Frage

Gibt es eine Möglichkeit mit Sphinx-Dokumentation einer Funktion oder Klasse Körper (den Code selbst) mit der Autodoc Funktion Ausgang? Ich verwende Autodoc zu viel Erfolg. Zusätzlich zu den Docstrings immer in der Dokumentation eingezogen ich wie ein Link wollen für jede Funktion klicken, wo es Sie die Quelle zeigen ... ist das möglich?

Dies ist über das, was die meisten meiner Dokumentation sieht aus wie jetzt:

   .. module:`foo.mymodule`

    Title
    ===================


    .. automodule:: foo.mymodule

    .. autoclass:: MyModulesClass
        :members:
        :undoc-members:
War es hilfreich?

Lösung

Wenn dies immer noch wichtig ist: Die Viewcode Erweiterung dies tun können, aber muss die Entwicklungsversion (1.0) von Sphinx

Andere Tipps

Ich glaube nicht. Autodoc ist nur zum Ziehen der Dokumentation aus dem Quellcode.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top