1.6 KiB
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