Refonte de la documentation #271
christophehenry
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
La documentation de django-dsfr semble avoir grandi de façon organique à partir de la nécessité de documenter de façon simple des tags Django eux-mêmes relativement simples. Malheureusement, le framework s'étant étoffé, la documentation s'est mise à documenter des concepts plus complexes, en plus d'intégrer des éléments qui sont présents ailleurs dans le code. Par exemple la page « contribuer » correspond à
CONTRIBUTING.md, quand toute la section formulaires est un bout de l'application d'exemple Django quand la documentation des composants eux-même est générée dynamiquement à partir des docstrings et de django-distill.À ce stade, il me semble que le projet est devenu suffisamment complexe pour justifier d'adopter une solution de documentation comme Sphinx (que Django utilise) et de déplacer la doc dans un dossier et des pages à part.
All reactions