A full guide to documenting code in Garnet can be found in the developer docs
Every module, class, and method should be documented with a docstring. Full documentation on the use of docstrings can be found in the sphinx docstring page
To build the documentation locally and view your changes:
cd docs/
make clean
make html
If you encounter any errors or warnings when building the docs, please be sure to fix them.
https://garnet-neutrons.readthedocs.io/en/latest/
sphinx.autodoc
Docstring Example
Sphinx Docsting Example
Getting started with Sphinx
Documenting Code with Sphinx
Sphinx Documentation