two/docs
2026-10-23 23:46:21 +02:00
..
architecture f-74: doc: vda racine, xvdX additionnels et /dev/xvdX par règle udev d'image, migration, notes de version #74 2026-10-23 17:19:16 +02:00
concepts f-75: doc: mode bridge sur plusieurs hôtes, interface_ip confinée à son hôte, notes de version #75 2026-10-23 23:42:47 +02:00
demarrage f-74: doc: vda racine, xvdX additionnels et /dev/xvdX par règle udev d'image, migration, notes de version #74 2026-10-23 17:19:16 +02:00
deploiement f-56: doc: MTU unique du cluster, underlay à 9000, section network, notes de version #56 2026-10-23 23:46:21 +02:00
developpement f-56: doc: MTU unique du cluster, underlay à 9000, section network, notes de version #56 2026-10-23 23:46:21 +02:00
exploitation f-56: doc: MTU unique du cluster, underlay à 9000, section network, notes de version #56 2026-10-23 23:46:21 +02:00
schemas f-70: doc: vue d'ensemble, poste de l'opérateur et accès à l'API publique de l'orchestrateur #70 2026-10-18 01:07: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-70: doc, e2e: VPC au masculin, générateurs des schémas d'architecture #70 2026-10-18 01:07: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 :

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.

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.