How To - Project Documentation

Get Started

Documentation can be written as rst files in the scram/docs/_source.

To build and serve docs, use the commands:

docker-compose -f local.yml up docs

Changes to files in docs/_source will be picked up and reloaded automatically.

Sphinx is the tool used to build documentation.

Docstrings to Documentation

The sphinx extension apidoc is used to automatically document code using signatures and docstrings.

Numpy or Google style docstrings will be picked up from project files and availble for documentation. See the Napoleon extension for details.

For an in-use example, see the page source for Users.

To compile all docstrings automatically into documentation source files, use the command:

make apidocs

This can be done in the docker container:

docker run --rm docs make apidocs