mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-24 17:31:16 +08:00
6b4b30e3fc
* initial commit: constant, normal, uniform * identity, glorot and he initializers * docstrings * rm file * nits * nits * nits * testing suite * docs * nits in docs * more docs * remove unused template * rename packakge to nn.innit * docs, receptive field * more docs --------- Co-authored-by: Awni Hannun <awni@apple.com> |
||
|---|---|---|
| .. | ||
| 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.