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 following:

cd $HOME/cosmoprimo/doc
make html

Documentation pages can be displayed by opening _build/html/index.html with your web browser.

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