Python-Sphinx - Nur Funktionssignatur mit Autodoc anzeigen?

Question

In Sphinx ist möglich, die Signatur einer Funktion oder Verfahren enthalten manuell die py:function (oder py:method) Direktive:

.. py:function:: my_func(data, named=None, *args, *kwargs) 

Es ist auch möglich autodoc Richtlinien zu verwenden aufzunehmen und Formatieren der gesamten docstring von eine Funktion oder Methode:

.. automethod:: my_func 

ich frage mich, ob es einen Weg gibt autodoc der Konfiguration der Rest des docstring aufzunehmen und die Unterschrift nur Format, ohne, so t Ich muss es nicht manuell machen.

Answer 1

Siehe autodoc sphinx.ext.autodoc.between.

Return ein Zuhörer, die entweder hält, oder wenn ausschließen Wahr umfasst nicht ist, Linien zwischen den Linien, die die Marker regulären Ausdruck übereinstimmen. Wenn keine Zeile übereinstimmt, ist der resultierende Docstring leer, so dass keine Änderung erfolgt, es sei denn, keepempty ist wahr.

Wenn was eine Folge von Strings ist, nur Docstrings eines Typs in was verarbeitet werden.