sphinx.ext.coverage --收集文档覆盖率统计

这个扩展包含一个额外的生成器， CoverageBuilder .

class sphinx.ext.coverage.CoverageBuilder

要使用此构建器，请在配置文件中激活Coverage扩展并提供 -M coverage 在命令行上。

待处理

写这部分。

可以使用多个配置值指定生成器应检查的内容：

coverage_ignore_modules

coverage_ignore_functions

coverage_ignore_classes

coverage_ignore_pyobjects

名单 Python regular expressions .

如果这些正则表达式中的任何一个与python对象的完整导入路径的任何部分匹配，则该python对象将从文档覆盖率报告中排除。

Added in version 2.1.

coverage_c_path

coverage_c_regexes

coverage_ignore_c_items

coverage_write_headline

设置为 False 不写标题。

Added in version 1.1.

coverage_skip_undoc_in_source

跳过源中没有用docstring记录的对象。 False 默认情况下。

Added in version 1.1.

coverage_show_missing_items

打印标准输出中缺少的对象。 False 默认情况下。

Added in version 3.1.

coverage_statistics_to_report

将覆盖范围统计数据的表格报表打印到覆盖范围报表。 True 默认情况下。

输出示例：

+-----------------------+----------+--------------+
| Module                | Coverage | Undocumented |
+=======================+==========+==============+
| package.foo_module    | 100.00%  | 0            |
+-----------------------+----------+--------------+
| package.bar_module    | 83.33%   | 1            |
+-----------------------+----------+--------------+

Added in version 7.2.

coverage_statistics_to_stdout

将覆盖范围统计数据的表格报告打印到标准输出。 False 默认情况下。

输出示例：

+-----------------------+----------+--------------+
| Module                | Coverage | Undocumented |
+=======================+==========+==============+
| package.foo_module    | 100.00%  | 0            |
+-----------------------+----------+--------------+
| package.bar_module    | 83.33%   | 1            |
+-----------------------+----------+--------------+

Added in version 7.2.