python - 是否可以针对特定功能覆盖 Sphinx autodoc？

Question

我正在使用 Sphinx 的 autodoc 插件来自动记录一组模块。我有一个接受 *args 的函数，我想覆盖文档以显示更好的 funcname(arg1[, arg2[, ...]]) Python stdlib 文档使用的样式。

是否可以覆盖特定函数的 autodoc 输出？

Answer 1

可以使用 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

也可以通过将签名作为函数文档字符串的第一行来覆盖签名。参见 this answer了解详情。