sphinx.ext.coverage – Collect doc coverage stats¶
This extension features one additional builder, the CoverageBuilder.
-
class
sphinx.ext.coverage.CoverageBuilder[source]¶ To use this builder, activate the coverage extension in your configuration file and give
-b coverageon the command line.
Todo
Write this section.
Several new configuration values can be used to specify what the builder should check:
-
coverage_ignore_modules¶
-
coverage_ignore_functions¶
-
coverage_ignore_classes¶
-
coverage_c_path¶
-
coverage_c_regexes¶
-
coverage_ignore_c_items¶
-
coverage_write_headline¶ Set to
Falseto not write headlines.New in version 1.1.
-
coverage_skip_undoc_in_source¶ Skip objects that are not documented in the source with a docstring.
Falseby default.New in version 1.1.