cqrenet/relay
3
0
Fork 0
mirror of https://github.com/chatmail/relay.git synced 2026-05-10 16:04:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(doc/README.md): scripts/initenv.sh should be used for building the docs

Browse Source 
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.
This commit is contained in:
link2xt
2026-04-22 18:22:01 +02:00
committed by l
parent a65f082817
commit 1e8c56e08a
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/README.md
View File

@@ -4,12 +4,14 @@
You can use the `make` command and `make html` to build web pages. You can use the `make` command and `make html` to build web pages.
You need a Python environment where the following install was excuted: You need a Python environment with `sphinx` and other
dependencies, you can create it by running `scripts/initenv.sh`
pip install furo sphinx-autobuild from the repository root.
To develop/change documentation, you can then do: To develop/change documentation, you can then do:
. venv/bin/activate
cd doc
make auto make auto
A page will open at https://127.0.0.1:8000/ serving the docs and it will A page will open at https://127.0.0.1:8000/ serving the docs and it will