抱歉,我是一个新手,试图添加 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
或命令行中配置选项。对于您的情况,请将其放在 conf.py
中您可以看到 extensions 的位置。 :
extensions = [
# Other extensions that you might already use
# ...
'sphinx.ext.coverage',
]
# ...
# Configuration of sphinx.ext.coverage
coverage_show_missing_items = True
关于python - 如何使用Sphix的sphinx.ext.coverage的coverage_show_missing_items?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/65944916/