sphinx.ext.coverage – Collecte les statistiques de couverture de doc

Cette extension comporte un constructeur supplémentaire, la classe CoverageBuilder.

class sphinx.ext.coverage.CoverageBuilder[source]

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

À faire

Écrivez cette section.

Plusieurs paramètres de configuration peuvent être utilisés pour spécifier ce que le constructeur doit vérifier:

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.

Added in version 2.1.

coverage_c_path
coverage_c_regexes
coverage_ignore_c_items
coverage_write_headline

Réglez sur « Faux » pour ne pas écrire de titres.

Added in version 1.1.

coverage_skip_undoc_in_source

Sauter les objets qui ne sont pas documentés dans le source avec une chaîne de caractères. « Faux » par défaut.

Added in version 1.1.

coverage_show_missing_items

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

Added in version 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            |
+-----------------------+----------+--------------+

Added in version 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            |
+-----------------------+----------+--------------+

Added in version 7.2.