From 1e8c56e08ac3fb801e4ddcd16afa83fe97e3ee50 Mon Sep 17 00:00:00 2001 From: link2xt Date: Wed, 22 Apr 2026 18:22:01 +0200 Subject: [PATCH] docs(doc/README.md): scripts/initenv.sh should be used for building the docs doc/README.md was outdated, it did not include sphinxcontrib-mermaid. Better use scripts/initenv.sh which already installs all dependencies and is used in CI. --- doc/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/README.md b/doc/README.md index b18b6346..7751b7ed 100644 --- a/doc/README.md +++ b/doc/README.md @@ -4,12 +4,14 @@ You can use the `make` command and `make html` to build web pages. -You need a Python environment where the following install was excuted: - - pip install furo sphinx-autobuild +You need a Python environment with `sphinx` and other +dependencies, you can create it by running `scripts/initenv.sh` +from the repository root. To develop/change documentation, you can then do: + . venv/bin/activate + cd doc make auto A page will open at https://127.0.0.1:8000/ serving the docs and it will