如何使用 Sphix 的 sphinx.ext.coverage 的 coverage_show_missing_items?
How to use Sphix's sphinx.ext.coverage's 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
不幸的是,我还没有想出 where/how 来设置这个配置。我的 Google-fu 没有提供任何有关如何配置这些设置的示例。
我猜它应该放在 conf.py
的某个地方,但还没有找到任何关于如何做的例子。
对于几乎每个 Sphinx 扩展,都可以在 conf.py
或命令行中配置选项。对于您的情况,请将其放在 conf.py
中您看到 extensions:
的某个位置
extensions = [
#...
sphinx.ext.coverage,
]
#...
# Configuration of sphinx.ext.coverage
coverage_show_missing_items = True
抱歉,我是一个新手,正在尝试将 Sphinx 添加到 Django 项目的自动生成文档中,并确保项目的文档覆盖面足够。
我想配置 Sphinx 以使用 coverage_show_missing_items
标志告诉我哪些对象缺少文档,在此处指定:
https://www.sphinx-doc.org/ar/master/usage/extensions/coverage.html#confval-coverage_show_missing_items
不幸的是,我还没有想出 where/how 来设置这个配置。我的 Google-fu 没有提供任何有关如何配置这些设置的示例。
我猜它应该放在 conf.py
的某个地方,但还没有找到任何关于如何做的例子。
对于几乎每个 Sphinx 扩展,都可以在 conf.py
或命令行中配置选项。对于您的情况,请将其放在 conf.py
中您看到 extensions:
extensions = [
#...
sphinx.ext.coverage,
]
#...
# Configuration of sphinx.ext.coverage
coverage_show_missing_items = True