Skip to content

Building documentation

This guide has been built using MkDocs and Material for MKDocs.

Follow mkdocs installation instructions, or just use:

pip install --user mkdocs mkdocs-material

To serve the documentation during the development use:

cd docs && mkdocs serve

Publish to GitHub pages

To build and public the documentation directly to GitHub pages:

cd docs && mkdocs gh-deploy