避免来自父对象的文档字符串，在Sphinx中 [英] Avoid docstrings from parent, in Sphinx

问题描述

我将Sphinx用于自动文档，但我发现它在默认情况下将父类docstring追加到我的文档字符串中的方式很烦人。

结果是，对于从unittest.TestCase继承的每个文档化测试类，我都会得到文档字符串"创建执行时将使用命名测试方法的类的实例。如果实例没有具有指定名称的方法，则引发ValueError。"。因此，这两句话一遍又一遍地散落在我的测试文档中。

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

推荐答案

有一个setting：

AutoDoc_Inherit_DOCSTRINGS

此值控制文档字符串继承。如果设置为True，则类或方法的文档字符串(如果未显式设置)是从(原文如此)父级继承的。

默认为True。

1.7版中的新功能。

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

这篇关于避免来自父对象的文档字符串，在Sphinx中的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！