sphinx.ext.coverage – Coleta estatísticas de cobertura da documentação

Essa extensão tem funcionalidades para construtor adicional, CoverageBuilder.

Nota

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.

Aviso

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.

Se os scripts do seu documento, (diferentemente de módulos de biblioteca), certificar-se que suas rotinas principais estejam protegidas por uma condição if __name__ == '__main__'.

Nota

For Sphinx (actually, the Python interpreter that executes Sphinx) to find your module, it must be importable. That means that the module or the package must be in one of the directories on sys.path – adapt your sys.path in the configuration file accordingly.

To use this builder, activate the coverage extension in your configuration file and run sphinx-build -M coverage on the command line.

Builder

class sphinx.ext.coverage.CoverageBuilder[código fonte]

Configuração

Vários valores de configuração podem ser usados para especificar o que o construtor deve verificar:

coverage_modules
Type:
list[str]
Default:
[]

List of Python packages or modules to test coverage for. When this is provided, Sphinx will introspect each package or module provided in this list as well as all sub-packages and sub-modules found in each. When this is not provided, Sphinx will only provide coverage for Python packages and modules that it is aware of: that is, any modules documented using the py:module directive provided in the Python domain or the automodule directive provided by the autodoc extension.

Adicionado na versão 7.4.

coverage_ignore_modules
coverage_ignore_functions
coverage_ignore_classes
coverage_ignore_pyobjects

Lista de expressões regulares do Python.

Se alguma dessas expressões regulares corresponder a qualquer parte do caminho completo de importação de um objeto Python, esse objeto Python será excluído do relatório de cobertura de documentação.

Adicionado na versão 2.1.

coverage_c_path
coverage_c_regexes
coverage_ignore_c_items
coverage_write_headline

Defina como False para não escrever títulos.

Adicionado na versão 1.1.

coverage_skip_undoc_in_source

Pula objetos que não estejam documentados no fonte com docstring. Falso por padrão.

Adicionado na versão 1.1.

coverage_show_missing_items

Imprime também objetos que estão faltando na saída padrão. False por padrão.

Adicionado na versão 3.1.

coverage_statistics_to_report

Imprime um relatório tabular das estatísticas de cobertura no relatório de cobertura. True por padrão.

Exemplo de saída:

+-----------------------+----------+--------------+
| 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

Imprime um relatório tabular das estatísticas de cobertura na saída padrão. Falso por padrão.

Exemplo de saída:

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

Adicionado na versão 7.2.