1:mod:`sphinx.ext.coverage` -- Collect doc coverage stats 2======================================================== 3 4.. module:: sphinx.ext.coverage 5 :synopsis: Check Python modules and C API for coverage in the documentation. 6 7This extension features one additional builder, the :class:`CoverageBuilder`. 8 9.. class:: CoverageBuilder 10 11 To use this builder, activate the coverage extension in your configuration 12 file and give ``-b coverage`` on the command line. 13 14.. todo:: Write this section. 15 16Several configuration values can be used to specify what the builder 17should check: 18 19.. confval:: coverage_ignore_modules 20 21.. confval:: coverage_ignore_functions 22 23.. confval:: coverage_ignore_classes 24 25.. confval:: coverage_ignore_pyobjects 26 27 List of `Python regular expressions`_. 28 29 If any of these regular expressions matches any part of the full import path 30 of a Python object, that Python object is excluded from the documentation 31 coverage report. 32 33 .. versionadded:: 2.1 34 35.. confval:: coverage_c_path 36 37.. confval:: coverage_c_regexes 38 39.. confval:: coverage_ignore_c_items 40 41.. confval:: coverage_write_headline 42 43 Set to ``False`` to not write headlines. 44 45 .. versionadded:: 1.1 46 47.. confval:: coverage_skip_undoc_in_source 48 49 Skip objects that are not documented in the source with a docstring. 50 ``False`` by default. 51 52 .. versionadded:: 1.1 53 54.. confval:: coverage_show_missing_items 55 56 Print objects that are missing to standard output also. 57 ``False`` by default. 58 59 .. versionadded:: 3.1 60 61.. _Python regular expressions: https://docs.python.org/library/re 62