Rédiger de la documentation

Schéma du projet

La documentation de Flower se trouve dans le répertoire docs. Le système de documentation basé sur Sphinx prend en charge à la fois les fichiers reStructuredText (.rst) et Markdown (.md).

Notez que, pour construire la documentation localement (avec uv run --project .. make html, comme décrit ci-dessous), Pandoc doit être installé sur le système.

Modifier une page existante

1. Modifier un fichier .rst (ou .md) existant sous framework/docs/source/

2. Compilez la documentation : cd framework/docs, puis uv run --project .. make html

3. Ouvre framework/docs/build/html/index.html dans le navigateur pour vérifier le résultat

Créer une nouvelle page

1. Ajouter un nouveau fichier .rst sous framework/docs/source/

2. Ajoute du contenu au nouveau fichier .rst

3. Lien vers le nouveau rst depuis index.rst

4. Compilez la documentation : cd framework/docs, puis uv run --project .. make html

5. Ouvre framework/docs/build/html/index.html dans le navigateur pour vérifier le résultat