显示*仅*狮身人面像文档中的文档字符串

Question

斯芬克斯有一个称为automethod特性，能在方法的文档字符串提取文档和嵌入了到的文档。但它不仅嵌入文档字符串，而且方法签名（名称+参数）。如何嵌入仅文档字符串（不包括方法签名）？

REF： http://sphinx.pocoo.org/ext/autodoc.html

Answer 1

我觉得你要寻找的是：

from sphinx.ext import autodoc

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

autodoc.add_documenter(DocsonlyMethodDocumenter)

每 rel="noreferrer">电流源这应该允许重写什么类是负责记录的方法（旧版本add_documenter的禁止这样的覆盖，但现在他们明确允许）。有format_args返回None，当然，是在autodoc所记录的方式说“不签字打扰。”

我认为这是执行此任务的清洁，架构方式，并且，因此，优选的Monkeypatching替代品。如果你需要忍受一些旧版本sphinx的，但是你可能确实有猴补丁（autodoc.MethodDocumenter.format_args=lambda _:None - 伊克 - ！），但我会建议升级sphinx到当前版本的更好的方法，如果在您的具体部署，在所有可行<。 / p>