QZT Dokumentation

Quickstart

Create & activate a virtual environment to avoid cluttering your system

python -m venv venv
source venv/bin/activate

Install dependencies

pip install -r requirements.txt

And serve a local development version

cd docs
sphinx-autobuild ./ ./_build/html

You can now access the documentation on http://127.0.0.1:8000. It will be rebuilt automatically upon file changes.

If you only want to build the static files once you can do make html.

Docker

Build the docker image with

docker build . -t sphinx-qzt

and use it to build the documentation like this

docker run --rm -v ./docs:/docs sphinx-qzt make html

Forgejo runner

Secret	Example	Description
DEPLOY_HOST	doku.queereszentrumtuebingen.de	Target host to deploy to
DEPLOY_USER	ci-documention	⚠️ Typo is intended - SSH username
DEPLOY_PATH	/static_sites/ci-documention/doku.queereszentrumtuebingen.de	Path where to deploy to
SSH_PRIVATE_KEY		Private key matching one in the server’s authorized_keys