sphinx.ext.coverage – 收集文档覆盖率统计¶
此扩展具有一个额外的构建器,即 CoverageBuilder .
待处理
编写此部分.
备注
The sphinx-apidoc command can be used to automatically generate API documentation for all code in a project, avoiding the need to manually author these documents and keep them up-to-date.
警告
coverage 导入 要记录的模块.如果任何模块在导入时有副作用,这些副作用将在运行 sphinx-build 时由覆盖构建器执行.
如果您记录的是脚本（与库模块相对）,请确保它们的主例程被 if __name__ == '__main__' 条件保护.
备注
为了让Sphinx（实际上是执行Sphinx的Python解释器）找到你的模块,它必须是可导入的.这意味着模块或包必须位于:data:sys.path 上的一个目录中——请相应地在配置文件中调整你的:data:sys.path .
要使用此构建工具,请在配置文件中激活覆盖率扩展,然后在命令行中运行 sphinx-build -M coverage .
构建器¶
配置¶
可以使用几个配置值来指定构建器应该检查什么:
- coverage_modules¶
- 类型:
list[str]- 默认:
[]
要测试覆盖率的 Python 包或模块的列表.当提供此列表时,Sphinx 将检查此列表中提供的每个包或模块,以及每个包和模块中找到的所有子包和子模块.当未提供此列表时,Sphinx 将仅提供它已知的 Python 包和模块的覆盖率:即,使用
py:module指令在 Python domain 中记录的任何模块,或者autodoc扩展提供的automodule指令.Added in version 7.4.
- coverage_ignore_modules¶
- coverage_ignore_functions¶
- coverage_ignore_classes¶
- coverage_ignore_pyobjects¶
List of 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¶
跳过源代码中没有文档字符串的对象.默认为
False.Added in version 1.1.
- coverage_show_missing_items¶
将缺失的对象也输出到标准输出.默认值为
False.Added in version 3.1.
- coverage_statistics_to_report¶
打印覆盖统计的表格报告以生成覆盖报告.默认值为
True.Example output:
+-----------------------+----------+--------------+ | 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.Example output:
+-----------------------+----------+--------------+ | Module | Coverage | Undocumented | +=======================+==========+==============+ | package.foo_module | 100.00% | 0 | +-----------------------+----------+--------------+ | package.bar_module | 83.33% | 1 | +-----------------------+----------+--------------+
Added in version 7.2.