sphinx.ext.coverage – Coleta estatísticas doc

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

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

Para usar esse construtor, ativar a cobertura da extensão no arquivo de configuração e usar -b coverage na linha de comando.

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.

Novo 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.

Novo 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.

Novo na versão 1.1.

coverage_show_missing_items

Print objects that are missing to standard output also. False by default.

Novo na versão 3.1.