Install Doxygen:

brew install doxygen

Install Python packages:

pip install -r requirements.txt

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>.

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.

To enable live refresh of docs while writing:

Install sphinx autobuild

pip install sphinx-autobuild

Run auto build on docs/src folder

sphinx-autobuild ./src ./build/html