two/docs
2026-10-24 00:01:45 +02:00
..
architecture f-80: doc: commandes, chemins et codes alignés sur le code, répertoire uefi, route reflectors, schémas régénérés #80 2026-10-24 00:00:08 +02:00
concepts f-80: doc: image, network-config réappliqué à chaque démarrage par l'événement boot-legacy de cloud-init #80 2026-10-24 00:01:45 +02:00
demarrage f-80: doc: commandes, chemins et codes alignés sur le code, répertoire uefi, route reflectors, schémas régénérés #80 2026-10-24 00:00:08 +02:00
deploiement f-80: doc: image, network-config réappliqué à chaque démarrage par l'événement boot-legacy de cloud-init #80 2026-10-24 00:01:45 +02:00
developpement f-80: doc: commandes, chemins et codes alignés sur le code, répertoire uefi, route reflectors, schémas régénérés #80 2026-10-24 00:00:08 +02:00
exploitation f-80: doc: commandes, chemins et codes alignés sur le code, répertoire uefi, route reflectors, schémas régénérés #80 2026-10-24 00:00:08 +02:00
schemas f-80: doc: commandes, chemins et codes alignés sur le code, répertoire uefi, route reflectors, schémas régénérés #80 2026-10-24 00:00:08 +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 ci: build and publish the documentation to the pages branch 2026-09-10 22:09:34 +02:00
index.rst f-50: lab: cycle de vie du serveur de lab Scaleway #50 2026-10-05 20:15:45 +02:00
README.md f-80: doc: commandes, chemins et codes alignés sur le code, répertoire uefi, route reflectors, schémas régénérés #80 2026-10-24 00:00:08 +02:00
requirements.txt docs: premiere creation de documentation 2026-08-26 23:41:50 +02:00

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, avec les mêmes options que la CI (avertissements bloquants) :

sphinx-build -b html -W --keep-going . _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.

Les schémas d'architecture (architecture-ensemble et architecture-cluster) sont générés : ne pas éditer leurs SVG, modifier schemas/gen_ensemble.py ou schemas/gen_cluster.py (même style, le second réutilise les fonctions du premier), puis régénérer les deux variantes :

python3 -B schemas/gen_ensemble.py schemas
python3 -B schemas/gen_cluster.py schemas

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.