Documentation

The documentation is built with MkDocs and the Material for MkDocs theme and is written in Markdown.

Building

To build the documentation site, first setup a Python virtual environment and install the mkdocs-material package, which will pull in all other dependencies:

virtualenv .venv
. .venv/bin/activate
pip install mkdocs-material

To build the docs, use the makefile target:

make docs

Launch a web server to pull up the docs and then point a browser at http://0.0.0.0:8000/ to view the site:

python3 -m http.server --directory site/