mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
![]() * wip: faster compiled kernels * faster general unary with uint specialization * index type in compiled, unary, binary, ternary, copy * fix jit * jit fix * specialize gather + scatter * nit in docs |
||
---|---|---|
.. | ||
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.