Documentation¶

This documentation is built with the Mkdocs static site generator.

Docs Setup¶

Python is required to build the docs, then run:

pip install mkdocs-material

To start the docs server, simply run:

mkdocs serve

The documentation will then be available on http://localhost:8000/

The command-line options are rebuilt using the docs/gen-cli.sh script.

Refer to the Mkdocs and Material for MkDocs pages for more info about the documentation.