Documentation

Project uses Sphinx to generate documentation from docstrings (documentation in-code) and custom pages written in Markdown (through the MyST parser).

To build it:

# build it
poetry run sphinx-build -b html -d docs/_build/cache -j auto docs docs/_build/html

Open docs/_build/index.html in a web browser.