Documentation guidelines

All new code should be clearly documented. For this new functions should contain docstrings. The API reference can then be automatically generated by using the run_apidoc function from conf.py. This function is automatically called with the command (call the commands from within the docs directory):

make html

and the documentation is saved in the auto_source directory.

Note

In case the documentation does not generate paths correctly you must remove the build folder

rm -rf build

Then run the following command again to generate a new build

make html