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

问题描述

抱歉，我是一个新手，试图添加 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 的某个地方，但没有遇到任何关于如何做的例子。

解决方法

对于几乎每个 Sphinx 扩展，都可以在 conf.py 或命令行中配置选项。对于您的情况，请将其放在您看到 extensions 的 conf.py 中：

extensions = [
    #...
    sphinx.ext.coverage,]

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