sphinx.ext.coverage --收集文档覆盖率统计信息¶
该扩展具有一个额外的构建器，即 CoverageBuilder 。
待处理
写下这一节。
备注
的 sphinx-apidoc 命令可用于为项目中的所有代码自动生成API文档，从而避免手动编写这些文档并使其保持最新。
警告
coverage imports the modules to be documented.
If any modules have side effects on import,
these will be executed by the coverage builder when sphinx-build is run.
如果您记录脚本（而不是库模块），请确保其主例程受到 if __name__ == '__main__' 条件
备注
对于Sphinx（实际上是执行Sphinx的Python解释器）来说，要找到你的模块，它必须是可导入的。这意味着模块或包必须位于 sys.path --调整你的 sys.path 相应地在配置文件中。
要使用此构建器，请激活配置文件中的cover扩展并运行 sphinx-build -M coverage 在命令行上。
Builder¶
配置¶
可以使用几个配置值来指定构建器应该检查的内容：
- coverage_modules¶
- 类型:
Sequence[str]- 默认:
()
要测试覆盖范围的Python包或模块列表。提供此功能后，Sphinx将内省此列表中提供的每个包或模块以及每个包或模块中找到的所有子包和子模块。如果不提供这一点，Sphinx将仅提供对其已知的Python包和模块的覆盖范围：即使用
py:module提供的指令 Python domain 或automodule指令由autodoc扩展名.Added in version 7.4.
- coverage_ignore_modules¶
- coverage_ignore_functions¶
- coverage_ignore_classes¶
- coverage_ignore_pyobjects¶
- 类型:
Sequence[str]- 默认:
()
列表 Python regular expressions 。
如果这些正则表达式中的任何一个与某个Python对象的完整导入路径的任何部分匹配，则该Python对象将从文档覆盖率报告中排除。
Added in version 2.1.
- coverage_c_path¶
- 类型:
Sequence[str]- 默认:
()
- coverage_c_regexes¶
- 类型:
dict[str, str]- 默认:
{}
- coverage_ignore_c_items¶
- 类型:
dict[str, Sequence[str]]- 默认:
{}
- coverage_write_headline¶
- 类型:
bool- 默认:
True
设置为
False不写头条新闻。Added in version 1.1.
- coverage_skip_undoc_in_source¶
- 类型:
bool- 默认:
False
跳过未在源代码中记录的对象。
Added in version 1.1.
- coverage_show_missing_items¶
- 类型:
bool- 默认:
False
还打印标准输出中缺少的对象。
Added in version 3.1.
- coverage_statistics_to_report¶
- 类型:
bool- 默认:
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¶
- 类型:
bool- 默认:
False
将覆盖率统计的表格式报告打印到标准输出。
输出示例：
+-----------------------+----------+--------------+ | Module | Coverage | Undocumented | +=======================+==========+==============+ | package.foo_module | 100.00% | 0 | +-----------------------+----------+--------------+ | package.bar_module | 83.33% | 1 | +-----------------------+----------+--------------+
Added in version 7.2.