Skip to content

Documentation

The structure of this documentation is based on the Diátaxis framework for technical documentation authoring.

https://www.mkdocs.org/

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Material for MkDocs

https://squidfunk.github.io/mkdocs-material/

mkdocstrings

Automatic documentation from sources, for MkDocs.

https://mkdocstrings.github.io/

MkDocs for building static pages from Markdown mkdocstrings for auto-generating documentation from docstrings in your code Material for MkDocs for styling your documentation