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 coverage on the command line.

Todo

Write this section.

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.

New in version 2.1.

coverage_c_path#
coverage_c_regexes#
coverage_ignore_c_items#
coverage_write_headline#

Set to False to 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. False by default.

New in version 1.1.

coverage_show_missing_items#

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

New in version 3.1.