Module documentant / corps classe / fonction dans python sphinx docs
-
11-09-2019 - |
Question
Est-il possible avec la documentation Sphinx pour produire un corps de la fonction ou la classe (le code lui-même) avec la fonction de autodoc? J'utilise autodoc à beaucoup de succès. En plus des docstrings s'élongations dans la documentation que je veux comme un lien à cliquer pour chaque fonction où il va vous montrer la source ... est-ce possible?
est de ce que la plupart de mes documents ressemble maintenant:
.. module:`foo.mymodule`
Title
===================
.. automodule:: foo.mymodule
.. autoclass:: MyModulesClass
:members:
:undoc-members:
La solution
Si cette question est importante encore: VIEWCODE l'extension peut le faire, mais a besoin de la version de développement (1.0) du Sphinx
Autres conseils
Je ne crois pas. Autodoc est seulement pour tirer la documentation sur le code source.
Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow