mlx/docs
Awni Hannun 226748b3e7
JIT compile option for binary minimization (#1091)
* 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
2024-05-22 12:57:13 -07:00
..
src JIT compile option for binary minimization (#1091) 2024-05-22 12:57:13 -07:00
.clang-format angelos's commit files 2023-11-29 10:42:59 -08:00
.gitignore Support LR schedulers (#334) 2024-02-15 11:26:20 -08:00
.nojekyll jagrit's commit files 2023-11-29 10:52:08 -08:00
Doxyfile Cpp docs (#1036) 2024-04-26 12:56:05 -07:00
index.html jagrit's commit files 2023-11-29 10:52:08 -08:00
Makefile angelos's commit files 2023-11-29 10:42:59 -08:00
README.md Cpp docs (#1036) 2024-04-26 12:56:05 -07:00
requirements.txt Cpp docs (#1036) 2024-04-26 12:56:05 -07:00

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.