2008-03-12 16:37:22 -05:00
|
|
|
:mod:`sphinx.ext.coverage` -- Collect doc coverage stats
|
|
|
|
|
========================================================
|
|
|
|
|
|
|
|
|
|
.. module:: sphinx.ext.coverage
|
|
|
|
|
:synopsis: Check Python modules and C API for coverage in the documentation.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This extension features one additional builder, the :class:`CoverageBuilder`.
|
|
|
|
|
|
|
|
|
|
.. class:: CoverageBuilder
|
|
|
|
|
|
|
|
|
|
To use this builder, activate the coverage extension in your configuration
|
|
|
|
|
file and give ``-b coverage`` on the command line.
|
|
|
|
|
|
2008-11-09 12:46:32 -06:00
|
|
|
.. todo:: Write this section.
|
2008-03-12 16:37:22 -05:00
|
|
|
|
2011-01-04 15:50:13 -06:00
|
|
|
|
2008-03-12 16:37:22 -05:00
|
|
|
Several new configuration values can be used to specify what the builder
|
|
|
|
|
should check:
|
|
|
|
|
|
|
|
|
|
.. confval:: coverage_ignore_modules
|
|
|
|
|
|
|
|
|
|
.. confval:: coverage_ignore_functions
|
|
|
|
|
|
|
|
|
|
.. confval:: coverage_ignore_classes
|
|
|
|
|
|
|
|
|
|
.. confval:: coverage_c_path
|
|
|
|
|
|
|
|
|
|
.. confval:: coverage_c_regexes
|
|
|
|
|
|
|
|
|
|
.. confval:: coverage_ignore_c_items
|
2011-01-04 15:22:23 -06:00
|
|
|
|
|
|
|
|
.. confval:: coverage_write_headline
|
2011-01-04 15:50:13 -06:00
|
|
|
|
|
|
|
|
Set to ``False`` to not write headlines.
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1
|
|
|
|
|
|
|
|
|
|
.. confval:: coverage_skip_undoc_in_source
|
|
|
|
|
|
|
|
|
|
Skip objects that are not documented in the source with a docstring.
|
|
|
|
|
``False`` by default.
|
|
|
|
|
|
|
|
|
|
.. versionadded:: 1.1
|
