Information for contributors¶
We would be happy to receive contributions!
Setting up the documentation build system¶
To install the necessary Python dependencies, create a virtual environment, e.g., with
virtualenv <environment>, and activate it afterwards with
<environment>/bin/activate. Then install the dependencies using
pip install sphinx pip install sphinxcontrib-matlabdomain pip install sphinxcontrib-bibtex pip install sphinx-rtd-theme
To build the documentation:
Activate the virtual environment where the necessary dependencies are installed in.
docs/, then run
make html. (To clean previously built documentation, run