diff options
| author | Georg Brandl <georg@python.org> | 2011-01-04 22:50:13 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2011-01-04 22:50:13 +0100 |
| commit | 66816e857e487e1803ed75bb5b39b8f534a79f37 (patch) | |
| tree | 4767323cbbd6292ff777fafffb6c9514f3c95cd4 /doc | |
| parent | 0d457902e9b984778ad8038178ed9da65bfb9954 (diff) | |
| download | sphinx-66816e857e487e1803ed75bb5b39b8f534a79f37.tar.gz | |
Add an option for the coverage builder if source-undocumented items are matched.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ext/coverage.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/ext/coverage.rst b/doc/ext/coverage.rst index 61395bf9..839478fe 100644 --- a/doc/ext/coverage.rst +++ b/doc/ext/coverage.rst @@ -14,6 +14,7 @@ This extension features one additional builder, the :class:`CoverageBuilder`. .. todo:: Write this section. + Several new configuration values can be used to specify what the builder should check: @@ -30,3 +31,14 @@ should check: .. confval:: coverage_ignore_c_items .. confval:: coverage_write_headline + + 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 |
