Python 如何使用Sphix';s sphinx.ext.coverage';s覆盖范围\u显示\u缺少\u项目?

Python 如何使用Sphix';s sphinx.ext.coverage';s覆盖范围\u显示\u缺少\u项目?,python,django,documentation,python-sphinx,documentation-generation,Python,Django,Documentation,Python Sphinx,Documentation Generation,很抱歉,我是一个新手,正在尝试添加Sphinx以自动生成Django项目的文档,并确保该项目有足够的文档覆盖率 我想配置Sphinx,通过使用此处指定的coverage\u show\u missing\u items标志来告诉我哪些对象缺少文档: 不幸的是,我无法确定在何处/如何设置此配置。我的Google fu没有提供任何关于如何配置这些设置的示例 我猜它应该放在conf.py的某个地方,但是没有遇到任何关于如何做的例子。几乎每个Sphinx扩展都可以在conf.py或命令行中配置选项。对

很抱歉,我是一个新手,正在尝试添加Sphinx以自动生成Django项目的文档,并确保该项目有足够的文档覆盖率

我想配置Sphinx,通过使用此处指定的
coverage\u show\u missing\u items
标志来告诉我哪些对象缺少文档:

不幸的是,我无法确定在何处/如何设置此配置。我的Google fu没有提供任何关于如何配置这些设置的示例


我猜它应该放在
conf.py
的某个地方,但是没有遇到任何关于如何做的例子。

几乎每个Sphinx扩展都可以在
conf.py
或命令行中配置选项。对于您的案例,请将其放在您的
conf.py
中的某个地方,您可以看到:

扩展=[
#...
斯芬克斯外景报道,
]
#...
#sphinx.ext.coverage的配置
覆盖率\u显示\u缺少\u项=真

谢谢史蒂夫。我应该猜到这只是普通的Python代码。只是好奇,也许你知道,但是覆盖范围扩展仍然没有告诉我哪些类没有记录在
docs/build/python.txt
中,我是否应该使用另一个设置让Sphinx告诉我哪些类需要记录或输出覆盖率百分比?如果这对你来说更容易,我很乐意发布另一个问题:)如果有用,我在运行sphinx时使用了:
sphinx build-b coverage docs/source/docs/build/