This is a guide to building documentation locally. Online documentation gets updated whenever master branch is updated.

Install sphinx, sphinx-rtd-theme, sphinxcontrib-napoleon, sphinx-autodoc-napoleon-typehints with pip.

1. Use sphinx-build

cd docs
sphinx-build -b html source build

The documentation is generated in html format and is in the docs/build folder. Start with index.html file.

2. Use the supplied makefile

cd docs
make html 

The documentation is generated in html format and is in the docs/build/html folder. Start with index.html file.

Whenever the code is updated, repopulate the code tree and run either step-1 or step-2.

cd docs
sphinx-apidoc -f -o source ../src/simsopt