sphinx.ext.coverage
This extension features one additional builder, the CoverageBuilder.
To use this builder, activate the coverage extension in your configuration file and give -b coverage on the command line.
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.
2.1
coverage_c_path
coverage_c_regexes
coverage_ignore_c_items
coverage_write_headline
Set to False to not write headlines.
1.1
coverage_skip_undoc_in_source
Skip objects that are not documented in the source with a docstring. False by default.
1.1
coverage_show_missing_items
Print objects that are missing to standard output also. False by default.
3.1
coverage_statistics_to_report
Print a tabluar 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 |
+-----------------------+----------+--------------+7.2
coverage_statistics_to_stdout
Print a tabluar 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 |
+-----------------------+----------+--------------+7.2