Documentare corpi modulo / classe / funzione in Python docs sfinge
-
11-09-2019 - |
Domanda
C'è un modo con Sfinge documentazione per produrre un corpo di funzione o di classe (il codice stesso) con la funzione autodoc? Sto usando autodoc a molto successo. Oltre ai docstrings ottenere tirato nella documentazione che voglio come un link da cliccare per ogni funzione, dove vi mostrerà la fonte ... è possibile?
Questo è su ciò che la maggior parte della mia documentazione si presenta come ora:
.. module:`foo.mymodule`
Title
===================
.. automodule:: foo.mymodule
.. autoclass:: MyModulesClass
:members:
:undoc-members:
Soluzione
Se questo è ancora importante: Il href="http://sphinx.pocoo.org/latest/ext/viewcode.html" rel="nofollow noreferrer"> ViewCode estensione può fare questo, ma richiede la versione di sviluppo (1.0) della Sfinge
Altri suggerimenti
Non credo così. Autodoc è solo per tirare fuori la documentazione del codice sorgente.