This is the documentation folder for the project. It uses sphinx to generate the documentation.

To build the documentation locally, you can use the nox session which handles all dependencies:

nox -s docs

Alternatively, if you prefer to install dependencies manually using the packages installed in your environement:

pip install -r requirements.txt

Then, you can build the documentation by running the following command:

sphinx-build -b html . public

You can then host locally the documentation by running the following command:

python -m http.server -d public

We are using the Google docstrings style (via the sphinx.ext.napoleon extension). Here is an example of a function with a docstring:

def func(arg1, arg2):
    """Summary line.

    Extended description of function.

    Args:
        arg1 (int): Description of arg1
        arg2 (str): Description of arg2

    Returns:
        bool: Description of return value

    """
    return True