Repository files navigation

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

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

The project requiresuv. Seehttps://docs.astral.sh/uv/getting-started/installation/for detailed instructions for installing uv.

A simple method to install uv is to usepipx. pipx can be installed withthe following command on Debian based systems:

sudo apt install pipx

Install uv using pipx

python3 -m pipx install uv

After installinguv, 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

Alternatively it is possible to start a local HTTP server that automaticallyrebuilds 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

The documentation usesSphinx in conjunction withmyst to create the HTML content. Eachdocument usesMarkdown withextended syntaxto integrate with Docutils and Sphinx. All Markdown files are in thesrc folder or one of its sub-folders.

The entry point is theindex.md file. It contains atoctree directiveto reference and include other Markdown files.

When a Pull Request is reviewed and merged, the HTML content is builtautomatically and published afterwards tohttps://greenbone.github.io/docs/via a GitHub Actionsworkflow.

For viewing the HTML content during development, please take a look at theauto rebuild and/ormanual build sections inthis README.