mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-25 01:41:17 +08:00
9a8ee00246
* mostly builds * most tests pass * fix circle build * add back buffer protocol * includes * fix for py38 * limit to cpu device * include * fix stubs * move signatures for docs * stubgen + docs fix * doc for compiled function, comments |
||
|---|---|---|
| .. | ||
| 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.