Building the documentation

If you are reading this, you probably do not need to build the documentation.

But you might want to build a local version anyway. As we also made the choice not to keep previous versions of the documentation online, you may want to recompile the doc for your local version of the code. The documentation relies on sphinx. The necessary packages can be installed using:

pip install nbsphinx sphinx-autoapi sphinx_rtd_theme
conda install sphinx # installs more (required) dependencies than pip

Then the documentation can be produced with:

python doc

This will create the documentation that you can check out by opening doc/html/index.html.