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

Question

我将 Sphinx 用于自动文档，但我发现它默认情况下如何将父类文档字符串附加到我的文档字符串中，这很烦人。

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

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

Answer 1

有一个设置：

autodoc_inherit_docstrings

该值控制文档字符串的继承。如果设置True为类或方法的文档字符串，如果未显式设置，则继承形式（原文如此）父母。

默认值为True.

1.7 版中的新功能。

尽管小心使用 - 此设置似乎破坏了我在文档字符串中调用的指令。