sphinx.ext.coverage – 收集doc覆盖率统计信息¶
此扩展包含一个额外的构建器, CoverageBuilder 。
-
class
sphinx.ext.coverage.CoverageBuilder[源代码]¶ 要使用此构建器,请激活配置文件中的 coverage 扩展,并在命令行上提供
-b coverage。
待处理
写这个部分。
可以使用多个配置值来指定构建器应检查的内容:
-
coverage_ignore_modules¶
-
coverage_ignore_functions¶
-
coverage_ignore_classes¶
-
coverage_c_path¶
-
coverage_c_regexes¶
-
coverage_ignore_c_items¶
-
coverage_write_headline¶ 设置为
False以不写标题。1.1 新版功能.
-
coverage_skip_undoc_in_source¶ 使用 docstring 跳过源中未记录的对象。
False默认情况下。1.1 新版功能.