Conventions de Documentation

Maintenir docs/index.md à jour

Quand un nouveau document markdown est ajouté sous docs/**/*.md ou qu'un fichier markdown est renommé, assurez-vous que @docs/index.md est mis à jour et que le document apparaît dans la section la plus appropriée.

Format des Docstrings

Utilisez des docstrings au style Google pour les classes et les fonctions. Ceux-ci sont analysables par Sphinx.

Pour les interfaces qui peuvent être utilisées en dehors d'un fichier, préférez les docstrings aux commentaires. Les commentaires doivent être réservés au code à l'intérieur d'une fonction ou aux interfaces locales à un fichier.

Documenter les Nouvelles Fonctionnalités

Quand une nouvelle fonctionnalité est ajoutée, mettez à jour ou créez de la documentation dans le répertoire docs/ qui correspond le plus étroitement à la fonctionnalité. Regardez la documentation existante pour trouver le meilleur ajustement — si aucune n'existe, créez un nouveau document et ajoutez-le à @docs/index.md.

Les modifications de documentation ne sont pas requises pour les corrections de bugs ou les modifications liées à la CI.