Python 是否可以为特定功能覆盖Sphinx autodoc？

我正在使用Sphinx的autodoc插件来自动记录一组模块。我有一个函数可以接受

*args

，我想重写文档，以显示Python stdlib文档使用的稍微好一点的

funcname（arg1[，arg2[，…]）

样式

---

是否可以覆盖特定功能的autodoc输出？

可以使用

autofunction

覆盖签名：

.. automodule:: yourmodule
   :members:
   :exclude-members: funcname

.. autofunction:: funcname(arg1[, arg2[, ...]])

但是，具有重写签名的函数不会与使用

automodule

拉入的其他函数排序。对每个函数使用显式的

autofunction

指令可以解决以下问题：

.. autofunction:: firstfunc

.. autofunction:: funcname(arg1[, arg2[, ...]])

.. autofunction:: thirdfunc

添加

您还可以将以下内容附加到文档字符串：

.. autofunction:: funcname(arg1[, arg2[, ...]])

   Extra documentation here.  

要覆盖签名和docstring，请使用

函数

而不是

自动函数

添加2

签名也可以通过将签名作为函数docstring的第一行来覆盖。有关详细信息，请参见。

+1了解“附加2”。覆盖文档字符串中的签名要比尝试排除成员，然后使用自定义签名重新添加成员等容易得多。