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

是否可以覆盖Sphinx 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.

要覆盖签名和文档字符串，请使用

function

代替

autofunction

。

加法2

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