Files
mlx/docs
Rahul Yedida cc05a281c4 Added ArcTan2 operation (#1079)
* Added ArcTan2 operation

* Cleanup, bug fixes from code review

* Minor cleanup, fixed Linux tests
2024-05-08 08:35:15 -07:00
..
2024-05-08 08:35:15 -07:00
2023-11-29 10:42:59 -08:00
2024-02-15 11:26:20 -08:00
2023-11-29 10:52:08 -08:00
2024-04-26 12:56:05 -07:00
2023-11-29 10:52:08 -08:00
2023-11-29 10:42:59 -08:00
2024-04-26 12:56:05 -07:00
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.