Rédiger de la documentation

Schéma du projet

La documentation de Flower se trouve dans le répertoire doc`. Le système de documentation basé sur Sphinx supporte à la fois reStructuredText (fichiers .rst) et Markdown (fichiers .md).

Note that, in order to build the documentation locally (with python -m poetry run make html, as described below), Pandoc needs to be installed on the system.

Modifier une page existante

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

2. Compile the docs: cd framework/docs, then python -m poetry run 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. Compile the docs: cd framework/docs, then python -m poetry run make html

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