sphinx.ext.coverage
– Recoge estadísticas de la cobertura de la documentación¶
Esta extensión cuenta con un constructor adicional, el CoverageBuilder
.
- class sphinx.ext.coverage.CoverageBuilder[fuente]¶
Para usar este constructor, activar la extensión coverage en el fichero de configuración y dar
-b coverage
en la línea de comandos.
Por hacer
Escribir esta sección.
Several configuration values can be used to specify what the builder should check:
- 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.
Nuevo en la versión 2.1.
- coverage_c_path¶
- coverage_c_regexes¶
- coverage_ignore_c_items¶
- coverage_write_headline¶
Establece en
False
para no escribir encabezados.Nuevo en la versión 1.1.
- coverage_skip_undoc_in_source¶
Ignorar objetos que no están documentados en la fuente con una docstring.
False
por defecto.Nuevo en la versión 1.1.
- coverage_show_missing_items¶
Print objects that are missing to standard output also.
False
by default.Nuevo en la versión 3.1.