Skip to content

Commit

Permalink
Change: Update README and add livehtml
Browse files Browse the repository at this point in the history
Improve the installation procedures in the README and add a section
about running a auto-rebuild web server.
  • Loading branch information
bjoernricks committed Feb 1, 2024
1 parent a9035d2 commit 4b6a980
Showing 1 changed file with 32 additions and 4 deletions.
36 changes: 32 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,25 @@
The documentation is build automatically via GitHub Actions and available at
https://greenbone.github.io/docs/

For a manual build locally [poetry](https://python-poetry.org/) is required.
## Requirements

First install poetry and the project dependencies with
For a manual build locally Python >= 3.9 and [poetry] is required.

## Install Dependencies

To install poetry it is recommended to use [pipx]
```sh
python3 -m pipx install poetry
```

To install the project dependencies via [poetry] run
```sh
python3 -m pip install poetry
poetry install
```

Afterwards the docs can be build with
## Manual Build

After installing [poetry] and the project's dependencies, the docs can be build with
```sh
poetry run make html
```
Expand All @@ -23,3 +33,21 @@ To open the generated HTML docs with Firefox you can run
```sh
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

```sh
poetry run make livehtml
```

To open the served docs with Firefox you can run

```sh
firefox http://127.0.0.1:8000
```

[poetry]: https://python-poetry.org/
[pipx]: https://pipx.pypa.io/stable/

0 comments on commit 4b6a980

Please sign in to comment.