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
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-rtd
and use it to build the documentation like this
docker run --rm -v ./docs:/docs sphinx-rtd make html
CI
Woodpecker can be used to deploy the documentation to a server. Fo that purpose it builds a docker container that contains sphinx and the read-the-docs theme, builds the documentation with that and pushes it to a server which will serve the static files.
| Key | Example | Description |
|---|---|---|
host |
dokumentation.notfellchen.org |
Hostename of the server where you want to deploy |
ssh_user |
username |
User on the server |
ssh_key |
-----BEGIN OPENSSH PRIVATE KEY----- |
The private SSH key of the user |
path |
/static_sites/static-hyteck/dokumentation.notfellchen.org |
Path where to deploy the static files. |
docker_username |
moanos |
Username authenticate to dockerhub to push the docker image |
docker_password |
SUPERSECRET |
Password authenticate to dockerhub to push the docker image |