Documentation¶
Documentation is generated using mkdocs, in conjunction with the mkdocs-material theme and docstring parsing with mkdocstrings.
Inspiration for generating API documentation was taken from mkdocstrings.
Inspiration for documentation formatting was taken from the pydantic documentation, which is also generated using mkdocs.
Offline¶
The documentation can be shared offline by running the following command from the project root:
The documentation will be generated in the site directory. The documentation can be viewed by opening site/index.html in a browser.