Kann ich die variable Erweiterung in der Sphinx-Dokumentation unterdrücken?

In meinem Code habe ich

X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation']

und später

def some_function(..., x=X_DEFAULT, ...):

so dass in meiner Sphinx-Dokumentation mit (z. B. mit.. autofunction::usw.) Ich bekomme den gesamten langen und unhandlichen Wert vonX_DEFAULT erweitert in der Signatur fürsome_function:

eine_funktion(..., x = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see' , 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'related', 'to', 'in', 'the', ' Dokumentation '], ...)

Gibt es eine Möglichkeit, diese Ersetzung in der generierten Dokumentation zu unterdrücken, idealerweise mit einem Link zurück zur Definition vonX_DEFAULT:

eine_funktion(..., x =X_DEFAULT, ...)

Mir ist bewusst, dass ich die Signatur für jede Funktion und Methode, die ich explizit als Argumente für Sphinx-Dokumentationsanweisungen aufführe, manuell überschreiben kann, aber das ist hier nicht mein Ziel. Mir ist auch bewusst, dass ich es gebrauchen könnteautodoc_docstring_signature und die erste Zeile der Docstring, aber das würde schlechte Docstrings erzeugen, die wirklich für Fälle gedacht sind, in denen die Introspektion fehlschlägt (wie C). Ich vermute, dass ich etwas tun könnteautodoc-process-signature Das könnte angemessen sein (aber nicht perfekt), obwohl ich nicht sicher bin, wie ich vorgehen soll.

Antworten auf die Frage(1)

Ihre Antwort auf die Frage