Python sphinx python sphinx-使用autodoc仅显示函数签名？

在Sphinx中，可以使用

py:function

（或

py:method

）指令手动包含函数或方法的签名：

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

还可以使用

autodoc

指令来包括函数或方法的整个docstring并对其进行格式化：

.. automethod:: my_func

我想知道是否有一种方法可以配置

autodoc

只包含签名并格式化，而不包含文档字符串的其余部分，这样我就不必手动执行了。

请参阅autodoc的

返回一个侦听器，该侦听器在与标记正则表达式匹配的行之间保留或（如果exclude为True）排除行。如果没有行匹配，则生成的docstring将为空，因此除非keepmpty为true，否则不会进行任何更改

如果what是一个字符串序列，则只处理what中某一类型的docstring

请参阅autodoc的

返回一个侦听器，该侦听器在与标记正则表达式匹配的行之间保留或（如果exclude为True）排除行。如果没有行匹配，则生成的docstring将为空，因此除非keepmpty为true，否则不会进行任何更改

如果what是一个字符串序列，则只处理what中某一类型的docstring

---

这里也可以使用autodoc流程签名

def process_signature(app, what, name, obj, options, signature, return_annotation):
    return modified_signature, modified_return_annotation
    # will be rendered to method(modified_signature) -> modified_return_annotation

def setup(app):
    app.connect("autodoc-process-signature", process_signature)

---

此处也可以使用autodoc流程签名

def process_signature(app, what, name, obj, options, signature, return_annotation):
    return modified_signature, modified_return_annotation
    # will be rendered to method(modified_signature) -> modified_return_annotation

def setup(app):
    app.connect("autodoc-process-signature", process_signature)