Wie würde ich das cross-Referenz-Funktion generiert autodoc in der Sphinx?

Ich bin mit dem Sphinx autodoc Funktion zum generieren von Dokumentation basiert auf den docstrings meine Python-Bibliothek.

Die syntax für cross-referencing ist gefunden hier

Muss ein label vor dem Abschnitt, um zu ermöglichen, dass Abschnitt verwiesen werden, die aus anderen Bereichen der Dokumentation.

Was ich habe ist ein .rst (ReStructeredText) - Datei für eine meiner Klassen. Es nutzt

.. autoclass:: classname
    :members:

Generierung von Dokumentation für die Klasse.

Meine Frage ist, wie würde ich mich auf die automatisch generierten Methoden der Klasse aus dem anderen .erste Dokument in der Dokumentation? Wenn ich versuche ein label innerhalb der Methode docstring, Sphinx beschwert. Wenn ich versuche, platzieren Sie ein label vor die Methode Position, Sphinx nicht zu erkennen.

Gibt es eine einfache Möglichkeit, dies zu tun, oder muss ich explizit schreiben, in meiner Klasse Datei den Namen der Methode, und vor, dass mit einem label?

Hier ist ein Beispiel für einen Verweis in der [Python-DokumentationZwei tun, was ich brauche (ich gehe davon aus, dass es verwendet den autodoc-Funktion, obwohl ich nicht sicher weiß)

Der Titel fragt nach Funktionen, doch der Körper und die Antwort auf die Frage Methoden. Ich hatte gehofft, es wäre eine Antwort für die Referenzierung eine .. autofunction:: aber leider ist es hier nicht.

InformationsquelleAutor Matthew Stamy | 2014-03-27

  1. 41

    Brauchen Sie nicht, um Beschriftungen hinzuzufügen. Um auf eine Python-Klasse, einer Methode oder einer anderen dokumentierten Objekt, verwenden Sie die markup zur Verfügung gestellt von der Python-domain.

    Beispielsweise die folgenden definiert einen Querverweis auf die mymethod Methode: 

    :py:meth:`mymodule.MyClass.mymethod`

    Oder noch einfacher (da die Python-domain ist die Standardeinstellung):

    :meth:`mymodule.MyClass.mymethod`

    In der Dokumentation von TextWrapper.wrap, dass Sie einen link in die Frage enthält zwei cross-Referenzen dieser Art (klicken Sie auf "Show" zu sehen, den reST markup).

    Und :mod:… für Module.
    Und :func:… für Funktionen. Eine vollständige Liste der, wie cross-Referenz-Python-Rollen hier.

    InformationsquelleAutor mzjn

Schreibe einen Kommentar