Documentation, available at docs.kustosz.org, 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 https://github.com/KustoszApp/docs
Create new virtual environment:
python3 -m venv path/to/virtualenv
Activate virtual environment:
pip install -r requirements.txt
Running current development version#
Kustosz documentation will be available at http://127.0.0.1:5500/. Website refreshes automatically as you change documentation source files.