docs: premiere creation de documentation
Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
This commit is contained in:
parent
9a46b5cde7
commit
cb904c4744
34 changed files with 1896 additions and 30 deletions
|
|
@ -1,11 +1,37 @@
|
|||
# Two docs
|
||||
# Documentation `two`
|
||||
|
||||
```
|
||||
export TMPDIR=$(mktemp -d)
|
||||
python -m venv ${TMPDIR}/venv
|
||||
Construction locale, avec rechargement automatique :
|
||||
|
||||
```bash
|
||||
TMPDIR=$(mktemp -d)
|
||||
python3 -m venv "${TMPDIR}/venv"
|
||||
source "${TMPDIR}/venv/bin/activate"
|
||||
python3.14 -m pip install --upgrade pip
|
||||
pip3.14 install -r requirements.txt
|
||||
pip install --upgrade pip
|
||||
pip install -r requirements.txt
|
||||
sphinx-autobuild . "${TMPDIR}/build"
|
||||
```
|
||||
|
||||
Construction simple :
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue