J'essaie d'utiliser Sphinx pour documenter un projet de plus de 5000 lignes en Python. Il a environ 7 modules de base. Pour autant que je sache, pour utiliser autodoc, je dois écrire un code comme celui-ci pour chaque fichier de mon projet: .. automodule:: mods.set.tests :members:...
Sphinx ne génère pas de documentation pour __init __ (self) par défaut. J'ai essayé ce qui suit: .. automodule:: mymodule :members: et ..autoclass:: MyClass :members: Dans conf.py, définir ce qui suit n'ajoute que la docstring __init __ (self) à la classe docstring ( la documentation de l'autodoc...
J'essaie de démarrer avec Sphinx et je semble avoir des problèmes incessants. Commander: docs/sphinx-quickstart Je réponds à toutes les questions et tout fonctionne bien. Commander: docs/ls Tout semble normal. Résultat:build Makefile source Commander: sphinx-build -d build/doctrees source...
J'utilise sphinx et le plugin autodoc pour générer la documentation API pour mes modules Python. Bien que je puisse voir comment documenter joliment des paramètres spécifiques, je ne trouve pas d'exemple sur la façon de documenter un **kwargsparamètre. Quelqu'un a-t-il un bon exemple d'une manière...