sphinx.ext.coverage – Collect doc coverage stats¶

This extension features one additional builder, the CoverageBuilder.

class sphinx.ext.coverage.CoverageBuilder¶

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

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¶