Building the Documentation

For building the documentation, we are using Sphinx. In order to build the documentation, you first need to set up your development environment and create a python environment. If not stated otherwise, all commands described are run from the docs folder of the pairinteraction repository.

In order to install all dependencies to smoothly run Sphinx, you should first run

pip install .[docs]

In order to build the documentation once, you can run

make html

You can then open the documentation by opening the file docs/_build/html/index.html with your browser.

Alternatively, you can let the documentation automatically rebuild by running

make livehtml

This will start a local web server that serves the documentation at http://127.0.0.1:8000 and automatically rebuilds the documentation whenever you change the source code or a documentation file.

Note

On Windows, you have to replace the command make by call make.bat