Building the Documentation

This documentation is built using MkDocs and is written in Markdown. It needs to be converted to HTML to be viewed in the desired format.

Prior to any build, you have to install the dependencies using Poetry:

poetry install

Building locally with live preview

To run a local webserver that automatically re-builds the documentation on changes run:

poetry run mkdocs serve

To build the full documentation for deployment on a webserver run:

poetry run mkdocs build

The resulting HTML files can be found in the site/ directory.

To build the full documentation for offline use without a webserver run:

OFFLINE=true poetry run mkdocs build

The resulting HTML files can be found in the site/ directory.