Documentation¶

Please follow Sphinx style guide 1 when writing the documentation (except for file names) and PEP257 2 for docstrings.

Building¶

The documentation can be built in or outside the Docker image:

cd $HOME/legacysim/doc
make html

Changes to the rst files can be made from outside the Docker container. Documentation pages can be displayed by opening _build/html/index.html with your web browser (outside the Docker container).

Finally, to push the documentation, Read the Docs 3.

References¶

1: https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html
2: https://www.python.org/dev/peps/pep-0257/
3: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/read-the-docs.html