Skip to content

Files

Latest commit

0992923 · May 16, 2024

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
May 16, 2024
Feb 26, 2024
Mar 8, 2024
Feb 26, 2024

Documentation

A full guide to documenting code in Garnet can be found in the developer docs

Documenting Code

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

Build the Documentation Locally

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.

Documentation Location

https://garnet-neutrons.readthedocs.io/en/latest/

Helpful resources

sphinx.autodoc
Docstring Example
Sphinx Docsting Example
Getting started with Sphinx
Documenting Code with Sphinx
Sphinx Documentation