python-sphinx - 只显示autodoc函数签名？

Question

在斯芬克斯可能包括的函数或方法手动使用py:function（或py:method）指令的签名：

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

另外，也可以使用autodoc指令包含和格式化的整个文档字符串一个函数或方法：

.. automethod:: my_func 

我想知道是否有配置autodoc包括和格式只有签名的方式，没有文档字符串的其余部分，因此T帽子我不必手动做。

Answer 1

查看autodoc的sphinx.ext.autodoc.between。

返回一个监听，要么保持，或如果排除为True排除，匹配标记正则表达式的线之间的线。如果没有行匹配，则生成的文档字符串将为空，因此不会进行更改，除非keepempty为true。

如果什么是串序列，在只有一个类型的文档字符串什么将被处理。