在Sphinx中避免来自父级的文档字符串

Question

我使用Sphinx进行autodocs，但我觉得它很烦人，默认情况下它将父类docstring附加到我的docstring。

结果是，对于从unittest.TestCase继承的每个记录的测试类，我得到docstring “创建将在执行时使用命名测试方法的类的实例。如果出现ValueError，则引发实例没有指定名称的方法。“追加。所以这两句话一遍又一遍地丢弃我的测试文档。

如何阻止Sphinx从父级中提取文档字符串？

Answer 1

有setting：

  

autodoc_inherit_docstrings

     

此值控制文档字符串继承。如果设置为True类或方法的docstring，如果没有显式设置，则是继承的表单（sic）父项。

     

默认值为True。

     

1.7版中的新功能。

尽管谨慎使用 - 此设置似乎打破了我在docstrings中调用的指令。