Docs creation

Docs creation#

In order to build the docs you need to

  1. install sphinx and additional support packages

  2. build the package reference files

  3. run sphinx to create a local html version

The documentation is build using readthedocs automatically.

Install the docs dependencies of the package (as speciefied in toml):

# in main folder
pip install ".[docs]"

Build docs using Sphinx command line tools#

Command to be run from path/to/docs, i.e. from within the docs package folder:

Options:

  • --separate to build separate pages for each (sub-)module

# pwd: docs
# apidoc
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/python_package
# build docs
sphinx-build -n -W --keep-going -b html ./ ./_build/
Contents