Skip to content

Contributing¤

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Environment setup¤

You only need two tools, PDM and Copier.

python3 -m pip install --user pipx
pipx install pdm
pipx install copier

Running tests¤

To run the tests, use:

make test

Serving docs¤

You can create a new virtualenv and install mkdocs and mkdocs-material:

python3 -m venv venv
. venv/bin/activate
pip install mkdocs mkdocs-material
mkdocs serve

You can also install mkdocs with pipx and inject mkdocs-material in its venv, this way you don't need to create one yourself:

python3 -m pip install --user pipx
pipx install mkdocs
pipx inject mkdocs mkdocs-material
mkdocs serve
Back to top