Contributing

Getting started

Start by cloning this repository and creating a virtual environment for python. From the repository root, install dependencies with

pip install --editable '.[dev]'

Run unit tests with

pytest

Documentation is based on mkdocs.

Start the live-reloading docs server:

mkdocs serve

Build the documentation site:

mkdocs build

Print help message and exit:

mkdocs -h