Documentation for the Greenbone Community Edition

The documentation is build automatically via GitHub Actions and available at https://greenbone.github.io/docs/

Requirements

For a manual build locally Python >= 3.9 and uv is required.

Install uv

The project requires uv. See https://docs.astral.sh/uv/getting-started/installation/ for detailed instructions for installing uv.

A simple method to install uv is to use pipx. pipx can be installed with the following command on Debian based systems:

sudo apt install pipx

Install uv using pipx

python3 -m pipx install uv

Manual Build

After installing uv, the docs can be built with:

uv run make html

To open the generated HTML docs with Firefox you can run:

firefox _build/html/index.html

Auto Rebuild

Alternatively it is possible to start a local HTTP server that automatically rebuilds the docs on every file change:

uv run make livehtml

To open the served docs with Firefox you can run:

firefox http://127.0.0.1:8000

Writing Content

The documentation uses Sphinx in conjunction with myst to create the HTML content. Each document uses Markdown with extended syntax to integrate with Docutils and Sphinx. All Markdown files are in the src folder or one of its sub-folders.

The entry point is the index.md file. It contains a toctree directive to reference and include other Markdown files.

When a Pull Request is reviewed and merged, the HTML content is built automatically and published afterwards to https://greenbone.github.io/docs/ via a GitHub Actions workflow.

For viewing the HTML content during development, please take a look at the auto rebuild and/or manual build sections in this README.