mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-24 17:31:16 +08:00
![]() * try cpp 20 for compile * unary, binary, ternary in jit * nits * fix gather/scatter * fix rebase * reorg compile * add ternary to compile * jit copy * jit compile flag * fix build * use linked function for ternary * some nits * docs + circle min size build * docs + circle min size build * fix extension * fix no cpu build * improve includes |
||
---|---|---|
.. | ||
src | ||
.clang-format | ||
.gitignore | ||
.nojekyll | ||
Doxyfile | ||
index.html | ||
Makefile | ||
README.md | ||
requirements.txt |
Build the Docs
Setup (do once)
Install Doxygen:
brew install doxygen
Install Python packages:
pip install -r requirements.txt
Build
Build the docs from mlx/docs/
doxygen && 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.