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。

如果什麼是串序列，在只有一個類型的文檔字符串什麼將被處理。