Documentation, available at, is written in MyST, which is CommonMark with support for Sphinx directives. Basically, it’s Markdown.

Documentation is built using Sphinx, which is Python package. It requires any Python 3 version supported by Sphinx.

Preparing development environment#

Clone Github repo:

git clone

Create new virtual environment:

python3 -m venv path/to/virtualenv

Activate virtual environment:

source path/to/virtualenv/bin/activate

Install dependencies:

pip install -r requirements.txt

Running current development version#

Run server:


Kustosz documentation will be available at Website refreshes automatically as you change documentation source files.