33# Documentation for the Greenbone Community Edition
44
55The documentation is build automatically via GitHub Actions and available at
6- https://greenbone.github.io/docs/
6+ [ https://greenbone.github.io/docs/ ] ( https://greenbone.github.io/docs/ )
77
88## Requirements
99
10- For a manual build locally Python >= 3.9 and [ poetry ] is required.
10+ For a manual build locally Python >= 3.9 and [ uv ] is required.
1111
12- ## Install Poetry
12+ ## Install uv
1313
14- The project requires poetry >= 1.8.0.
14+ The project requires [ uv] . See [ https://docs.astral.sh/uv/getting-started/installation/ ] ( https://docs.astral.sh/uv/getting-started/installation/ )
15+ for detailed instructions for installing uv.
1516
16- To install poetry it is recommended to use [ pipx] . pipx can be installed with
17+ A simple method to install uv is to use [ pipx] . pipx can be installed with
1718the following command on Debian based systems:
1819
1920``` sh
2021sudo apt install pipx
2122```
2223
23- Install poetry using pipx
24+ Install uv using pipx
2425
2526``` sh
26- python3 -m pipx install poetry
27+ python3 -m pipx install uv
2728```
2829
29- ## Install and Upgrade Dependencies
30-
31- When building the docs you should ensure that all the dependencies are installed
32- and up to date. To install for the first time or to update the project
33- dependencies via [ poetry] run:
34-
35- ``` sh
36- poetry install
37- ```
38-
39- You should run this command once a week to install the latest dependencies.
40-
4130## Manual Build
4231
43- After installing [ poetry ] and the project's dependencies , the docs can be built with:
32+ After installing [ uv ] , the docs can be built with:
4433
4534``` sh
46- poetry run make html
35+ uv run make html
4736```
4837
4938To open the generated HTML docs with Firefox you can run:
@@ -58,7 +47,7 @@ Alternatively it is possible to start a local HTTP server that automatically
5847rebuilds the docs on every file change:
5948
6049``` sh
61- poetry run make livehtml
50+ uv run make livehtml
6251```
6352
6453To open the served docs with Firefox you can run:
@@ -67,23 +56,5 @@ To open the served docs with Firefox you can run:
6756firefox http://127.0.0.1:8000
6857```
6958
70- ## Starting From Scratch
71-
72- If something is wrong with your dependencies or you just want to re-start from
73- a clean environment you need to remove the [ virtual environment] ( https://docs.python.org/3/library/venv.html ) .
74- First of all ensure that poetry's virtual environment is placed within the
75- project:
76-
77- ``` sh
78- poetry config virtualenvs.in-project true
79- ```
80-
81- Afterwards the virtual environment including all installed dependencies can be
82- deleted:
83-
84- ``` sh
85- rm -rf .venv
86- ```
87-
88- [ poetry ] : https://python-poetry.org/
59+ [ uv ] : https://docs.astral.sh/uv/
8960[ pipx ] : https://pipx.pypa.io/stable/
0 commit comments