mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
2629cc8682
* Add notes about MacOS version restrictions for mlx in install docs * Add notes about Xcode version requirements for building from source in install docs * Let make detect the macosx sdk version being used * Throw error if trying to build metal kernels with macOS <= 13.4 * Add metal-cpp for macOS 14.2 |
||
|---|---|---|
| .. | ||
| src | ||
| .clang-format | ||
| .gitignore | ||
| .nojekyll | ||
| index.html | ||
| Makefile | ||
| README.md | ||
Build the Docs
Setup (do once)
Install sphinx
for example with conda:
conda install sphinx
pip install sphinx-book-theme
Build
Build the docs from mlx/docs/
make html
View the docs by running a server in mlx/docs/build/html/:
python -m http.server <port>
and point your browser to http://localhost:<port>.
Push to Github Pages
Check-out the gh-pages branch (git switch gh-pages) and build
the docs. Then force add the build/html directory:
git add -f build/html
Commit and push the changes to the gh-pages branch.