如何使用Sphix的sphinx.ext.coverage的coverage_show_missing_items？

Question

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

我想配置 Sphinx 以使用

coverage_show_missing_items

标志告诉我哪些对象缺少文档，在此处指定：
https://www.sphinx-doc.org/ar/master/usage/extensions/coverage.html#confval-coverage_show_missing_items

不幸的是，我无法弄清楚在哪里/如何设置这个配置。我的 Google-fu 没有提供任何有关如何配置这些设置的示例。

我猜它应该放在里面

conf.py

某处，但还没有遇到任何关于如何做的例子。

Answer 1

对于几乎每个 Sphinx 扩展，都可以在

conf.py

或命令行中配置选项。对于你的情况，把这个放在你的

conf.py

你看到extensions的地方：

extensions = [
    # Other extensions that you might already use
    # ...
    'sphinx.ext.coverage',
]

# ...
# Configuration of sphinx.ext.coverage
coverage_show_missing_items = True