Installation

Environment

This project uses Pixi for package management. Pix supports Windows, MacOS, and Linux. See the Pixi documentation for more information how to install pixi.

To install the environment, run the following command for the project root directory:

pixi install

Documentation

Preview

Run

mkdocs serve

to start the live-reloading docs server.

The local website is run on http://127.0.0.1:8000/participation_certificate/

MacOS-Error

no library called "cairo-2" was found…

can be fixed with:

export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib
mkdocs serve

See here for details

Publishing

The documentation website is hosted at GitHub pages.

To deploy:

mkdocs gh-deploy

MacOS-Error

no library called "cairo-2" was found…

can be fixed with:

export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib
mkdocs gh-deploy

before running mkdocs gh-deploy to install the cairo library.

Versioning Schema

The versioning schema is {major}.{minor}.{patch}[{release}{build}] where the latter part (release and build) is optional.

It is recommended to do --dry-run prior to your actual run.

# increase version identifier
bumpversion [major/minor/patch/release/build]  # --verbose --dry-run

# e.g.
bumpversion minor  # e.g. 0.5.1 --> 0.6.0
bumpversion minor --new-version 0.7.0  # e.g. 0.5.1 --> 0.7.0