|
All checks were successful
Documentation / publish (push) Successful in 1m28s
Release Pipeline / set-release-target (push) Successful in 2s
Release Pipeline / upload-assets (agent.service, systemd/agent.service) (push) Successful in 7s
Release Pipeline / upload-assets (dhcp@.service, systemd/dhcp@.service) (push) Successful in 7s
Release Pipeline / upload-assets (dnsmasq@.service, systemd/dnsmasq@.service) (push) Successful in 7s
Release Pipeline / upload-assets (metadata@.service, systemd/metadata@.service) (push) Successful in 7s
Release Pipeline / upload-assets (run-dhcp-in-netns.sh, scripts/run-dhcp-in-netns.sh) (push) Successful in 7s
Release Pipeline / upload-assets (run-dnsmasq-in-netns.sh, scripts/run-dnsmasq-in-netns.sh) (push) Successful in 7s
Release Pipeline / build (agent, amd64, linux) (push) Successful in 0s
Release Pipeline / build (dhcp, amd64, linux) (push) Successful in 0s
Release Pipeline / build (metadata, amd64, linux) (push) Successful in 0s
Release Pipeline / checksums (push) Successful in 8s
Release Pipeline / build (push) Successful in 2m21s
Release Pipeline / release (push) Successful in 31s
Release Pipeline / publish (push) Successful in 0s
Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr> |
||
|---|---|---|
| .. | ||
| architecture | ||
| concepts | ||
| demarrage | ||
| deploiement | ||
| developpement | ||
| exploitation | ||
| schemas | ||
| versions | ||
| conf.py | ||
| index.rst | ||
| README.md | ||
| requirements.txt | ||
Documentation two
Construction locale, avec rechargement automatique :
TMPDIR=$(mktemp -d)
python3 -m venv "${TMPDIR}/venv"
source "${TMPDIR}/venv/bin/activate"
pip install --upgrade pip
pip install -r requirements.txt
sphinx-autobuild . "${TMPDIR}/build"
Construction simple :
sphinx-build -b html . _build/html
La référence de l'API est générée depuis ../api/agent.yaml : c'est la source unique du
contrat, la documentation ne la recopie pas.
Schémas
Les schémas simples sont en mermaid, directement dans les pages. Les schémas travaillés sont des
SVG dans schemas/, en deux variantes :
schemas/<nom>.svg thème clair → .. figure:: /schemas/<nom>.svg :class: only-light
schemas/<nom>-dark.svg thème sombre → .. figure:: /schemas/<nom>-dark.svg :class: only-dark
schemas/ est dans exclude_patterns : Sphinx n'y cherche pas de pages, mais copie les fichiers
référencés par une directive figure ou image.
Un export draw.io se dépose tel quel sous ce nom. Exporter en SVG éditable (« Include a copy of my diagram ») pour pouvoir rouvrir le fichier dans draw.io ensuite.