syonad/two
2
0
Fork 0
Code Issues 16 Pull requests 1 Projects Releases 4 Packages Wiki Activity Actions
two/docs
History
GnomeZworc eee15eb68e
 f-46: doc: document the dhcp backend and its switch procedure #46 
Note de version 0.2.0 (Bael), et reprise des huit pages de docs/ qui parlaient
de dnsmasq ou du DHCP.

Ajouts de fond : la section Backend DHCP de la page de configuration, avec la
procédure de bascule manuelle et l'avertissement qu'elle ne migre rien ; la
section du serveur intégré dans les services ; et dans la page de diagnostic
comment interroger la socket de contrôle, probe étant le point de départ le plus
rapide quand une VM n'obtient pas d'adresse.

Le nom de version se déduit du rang, pas du numéro : deuxième release, deuxième
nom de codenames.md.

Construit avec sphinx-build -W --keep-going, sans avertissement.

Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
2026-09-09 22:38:27 +02:00
..
architecture f-46: doc: document the dhcp backend and its switch procedure #46 2026-09-09 22:38:27 +02:00
concepts f-46: doc: document the dhcp backend and its switch procedure #46 2026-09-09 22:38:27 +02:00
demarrage f-46: doc: document the dhcp backend and its switch procedure #46 2026-09-09 22:38:27 +02:00
deploiement docs: configuration for orchestrator 2026-08-27 23:56:47 +02:00
exploitation f-46: doc: document the dhcp backend and its switch procedure #46 2026-09-09 22:38:27 +02:00
schemas docs: premiere creation de documentation 2026-08-26 23:41:50 +02:00
versions f-46: doc: document the dhcp backend and its switch procedure #46 2026-09-09 22:38:27 +02:00
conf.py docs: premiere creation de documentation 2026-08-26 23:41:50 +02:00
index.rst docs: configuration for orchestrator 2026-08-27 23:56:47 +02:00
README.md docs: premiere creation de documentation 2026-08-26 23:41:50 +02:00
requirements.txt docs: premiere creation de documentation 2026-08-26 23:41:50 +02:00

README.md

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.