sphinx.ext.coverage
– Coleta estatísticas doc¶
Essa extensão tem funcionalidades para construtor adicional, CoverageBuilder
.
- class sphinx.ext.coverage.CoverageBuilder[código fonte]¶
To use this builder, activate the coverage extension in your configuration file and give
-M coverage
on the command line.
Por fazer
Escrever essa seção.
Vários valores de configuração podem ser usados para especificar o que o construtor deve verificar:
- coverage_ignore_modules¶
- coverage_ignore_functions¶
- coverage_ignore_classes¶
- coverage_ignore_pyobjects¶
List of Python regular expressions.
If any of these regular expressions matches any part of the full import path of a Python object, that Python object is excluded from the documentation coverage report.
Adicionado na versão 2.1.
- coverage_c_path¶
- coverage_c_regexes¶
- coverage_ignore_c_items¶
- coverage_write_headline¶
No modo
Falso
não grava linhas de cabeçalhos.Adicionado na versão 1.1.
- coverage_skip_undoc_in_source¶
Pular objetos que não estejam documentados no fonte com docstring.
Falso
por padrão.Adicionado na versão 1.1.
- coverage_show_missing_items¶
Print objects that are missing to standard output also.
False
by default.Adicionado na versão 3.1.
- coverage_statistics_to_report¶
Print a tabular report of the coverage statistics to the coverage report.
True
by default.Example output:
+-----------------------+----------+--------------+ | Module | Coverage | Undocumented | +=======================+==========+==============+ | package.foo_module | 100.00% | 0 | +-----------------------+----------+--------------+ | package.bar_module | 83.33% | 1 | +-----------------------+----------+--------------+
Adicionado na versão 7.2.
- coverage_statistics_to_stdout¶
Print a tabular report of the coverage statistics to standard output.
False
by default.Example output:
+-----------------------+----------+--------------+ | Module | Coverage | Undocumented | +=======================+==========+==============+ | package.foo_module | 100.00% | 0 | +-----------------------+----------+--------------+ | package.bar_module | 83.33% | 1 | +-----------------------+----------+--------------+
Adicionado na versão 7.2.