J'essaie d'utiliser Sphinx pour documenter un projet de plus de 5 000 lignes en Python. Il comporte environ 7 modules de base. Pour autant que je sache, afin d'utiliser autodoc, je dois écrire un code comme celui-ci pour chaque fichier de mon projet :
.. automodule:: mods.set.tests
:members:
:show-inheritance:C'est beaucoup trop fastidieux car j'ai beaucoup de fichiers. Ce serait beaucoup plus facile si je pouvais juste spécifier que je veux que le paquet 'mods' soit documenté. Sphinx pourrait alors parcourir récursivement le paquet et créer une page pour chaque sous-module.
Existe-t-il une fonctionnalité de ce type ? Sinon, je pourrais écrire un script pour créer tous les fichiers .rst, mais cela prendrait beaucoup de temps.
143 votes
Personne n'a dit que c'était difficile. L'OP a dit que c'était fastidieux ce qui est le cas. Étant donné que d'autres systèmes de documentation peuvent le faire, ce n'est pas déraisonnable.
0 votes
Il suffit d'utiliser pdoc .