README.md

Documentation for the Greenbone Community Edition

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

For a manual build locally poetry is required.

First install poetry and the project dependencies with

python3 -m pip install poetry
poetry install

Afterwards the docs can be build with

poetry run make html

To open the generated HTML docs with Firefox you can run

firefox _build/html/index.html