mlx/docs
K Venkat Ramnan ab977109db
feat: Added dlpack device (#1165)
* feat: Added dlpack device

* feat: Added device_id to dlpack device

* feat: Added device_id to dlpack device

* doc: updated conversion docs

* doc: updated numpy.rst dlpack information

* doc: updated numpy.rst dlpack information

* Update docs/src/usage/numpy.rst

* Update docs/src/usage/numpy.rst

---------

Co-authored-by: Venkat Ramnan Kalyanakumar <venkatramnankalyanakumar@Venkats-MacBook-Air.local>
Co-authored-by: Awni Hannun <awni.hannun@gmail.com>
2024-05-31 12:29:01 -07:00
..
src feat: Added dlpack device (#1165) 2024-05-31 12:29:01 -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.