大佬教程收集整理的这篇文章主要介绍了如何使用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
以上是大佬教程为你收集整理的如何使用Spix的sphinx.ext.coverage的coverage_show_missing_items?全部内容,希望文章能够帮你解决如何使用Spix的sphinx.ext.coverage的coverage_show_missing_items?所遇到的程序开发问题。
如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。