Documentation

This documentation is all built using MkDocs with the Material theme.

Their documentation is brilliant so please check their docs if this is not sufficient.

Please ensure this documentation is updated whenever changes are made to the source code / configuration.

Note

The source for these docs lives in the docs directory within the repo.

All the following commands assume you've cd'd into the docs directory.

Installing Dependencies

Ensure Python is installed on your system.

Tested on python v3.13.0

# Install all dependencies
pip install -r requirements.txt

Run the following to start the server.

This supports hot reloading so updating the docs should automatically reload the docs in your browser.

mkdocs serve

The docs also uses the mkdocs-macros plugin. This lets us call out to python code (and a load of other features) from within markdown.

See the main.py file which includes some useful macros.

This is all quite self explanatory when you look at the code.

Run the following:

bundle exec fastlane generate_docs

This will generate the dokka documentation and put the website together.