Python Sphinx/Rest Substitution für lange Namen zu definieren Substitutionsregel in der gleichen Quelldatei

Question

Beitrag Python Sphinx referencing long names zur Verfügung gestellt eine Antwort, die sehr nahe war, was ich in Bezug auf Substitutionsrichtlinien für lange Klassennamen suchte.

In dem Beispiel, das bereitgestellt wird, befindet sich die Definition für Ersetzungsregel jedoch in demselben Pydoc-Block. Ich habe gehofft, so etwas zu tun:

"""define all rst links/substitutions used in this file 
.. |ReallyLongExampleClassName| replace:: :class:`.ReallyLongExampleClassName` 
.. |AnotherExampleClassName| replace:: :class:`.AnotherExampleClassName` 
""" 

# more code 
# more code 


def exampleFunction(): 
    '''Here is an example docstring referencing another 
    |ReallyLongExampleClassName| 

    # define function 

Da jede Datei in Frage spezifisch ist, die Verwendung des rst_epilog nicht sehr gut verlaufen. Ist das überhaupt möglich?

Answer 1

Sie können dies mit der Variablen in Ihrer conf.py Datei tun. Dies wird gerade von rst_epilog genommen:

rst_epilog

Eine Reihe von reStructuredText, die am Ende jeder Quelldatei aufgenommen werden, die gelesen wird. Dies ist der richtige Ort, um Substitutionen hinzuzufügen, die in jeder Datei verfügbar sein sollten. Ein Beispiel:

rst_epilog = """ 
.. |psf| replace:: Python Software Foundation 
""" 

Aber Sie sagen, dass rst_epilog nicht eine gute Passform für Ihren Anwendungsfall ist. Vielleicht ist die erste include directive ein besserer Ansatz? Sie können Ihre häufig verwendeten Ersetzungen in ein einziges Dokument einfügen und in die Dokumente einfügen, in denen Sie sie verwenden müssen.