Files
mlx/docs
Nripesh Niketan 6af5ca35b2 feat: add cross_product (#1252)
* feat: add cross_product

* lint

* python binding

* refactor: Improve error message for cross_product function

* refactor: more close to numpy cross product

* refactor: improve error message for cross_product function

* finish

* fix acks

* allow old numpy

* doc

---------

Co-authored-by: Awni Hannun <awni@apple.com>
2024-09-17 13:12:43 -07:00
..
2024-09-17 13:12:43 -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

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.