mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-25 09:51:17 +08:00
dff4a3833f
* update module to check weights on load, also fix docs and reorganize tests * nits + rebase * a few more docs updates for Module * use manual module file * comment |
||
|---|---|---|
| .. | ||
| 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.