Ich benutze dieSphinx autodoc Funktion zum Generieren von Dokumentation basierend auf den Dokumentzeichenfolgen meiner Python-Bibliothek.

Die Syntax für Querverweise wurde gefundenHier

Vor dem Abschnitt muss ein Etikett stehen, damit auf diesen Abschnitt aus anderen Bereichen der Dokumentation verwiesen werden kann.

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

.. autoclass:: classname
    :members:

So generieren Sie die Dokumentation für die Klasse.

Meine Frage ist, wie würde ich auf die automatisch generierten Methoden der Klasse aus einem anderen .rst-Dokument in der Dokumentation verweisen? Wenn ich versuche, eine Beschriftung in den Docstring der Methode einzufügen, beschwert sich Sphinx. Wenn ich versuche, ein Label vor der Überschrift der Methode zu platzieren, erkennt Sphinx es nicht.

Gibt es eine einfache Möglichkeit, dies zu tun, oder muss ich den Methodennamen explizit in meine Klassendatei schreiben und ihm ein Label voranstellen?

Hier ist ein Beispiel einer Referenz in der [Python-Dokumentation2 tun, was ich brauche (ich gehe davon aus, dass es die Autodoc-Funktion verwendet hat, obwohl ich nicht sicher bin)