The doc/ folder contains the files for building the pyPESTO documentation.


The documentation is based on sphinx. Install via

pip3 install sphinx

Furthermore, the files specified in ../.rtd_pip_reqs.txt and ../.rtd_apt_reqs.txt are required. Install via

pip3 install --upgrade -r ../.rtd_pip_reqs.txt


cat ../.rtd_apt_reqs.txt | xargs sudo apt install -y


Build the documentation

The documentation can be built in different formats, e.g. in html via

make html

The built documentation can then be found locally in the _build sub-directory.

The documentation is built and published automatically on every time the master branch on is changed. It is recommended to compile and check the documentation manually beforehand.