在 Sphinx 文档中*仅*显示文档字符串？

Question

Sphinx 有一个名为 automethod 的功能，可以从方法的文档字符串中提取文档并将其嵌入到文档中。但它不仅嵌入了文档字符串，还嵌入了方法签名（名称+参数）。如何仅嵌入文档字符串（不包括方法签名）？

参考： http://www.sphinx-doc.org/ en/master/usage/extensions/autodoc.html

Answer 1

我认为您正在寻找的是：

from sphinx.ext import autodoc

class DocsonlyMethodDocumenter(autodoc.MethodDocumenter):
  def format_args(self):
    return None

autodoc.add_documenter(DocsonlyMethodDocumenter)

根据当前来源< /a> 这应该允许覆盖负责记录方法的类（旧版本的 add_documenter 禁止此类覆盖，但现在明确允许）。当然，让 format_args 返回 None 是 autodoc 中记录的方式，表示“不用理会签名”。

我认为这是执行此任务的干净、架构化的方式，因此比猴子补丁替代方案更可取。如果您需要使用一些旧版本的sphinx，但是您可能确实需要monkeypatch（autodoc.MethodDocumenter.format_args=lambda _:None - eek!-）如果在您的特定部署中可行的话，我建议将 sphinx 升级到当前版本作为更好的方法。