~ubuntuone-pqm-team/sphinx/stable

« back to all changes in this revision

Viewing changes to doc/ext/coverage.rst

• browse files at revision 1
• compare with another revision
• download diff
• download tarball
• view history from revision 1

Show diffs side-by-side

added

removed

doc/ext/coverage.rst

 

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

 

 

7

 

 

8

This extension features one additional builder, the :class:`CoverageBuilder`.

 

9

 

 

10

.. class:: CoverageBuilder

 

11

 

 

12

   To use this builder, activate the coverage extension in your configuration

 

13

   file and give ``-b coverage`` on the command line.

 

14

 

 

15

.. todo:: Write this section.

 

16

 

 

17

 

 

18

Several new configuration values can be used to specify what the builder

 

19

should check:

 

20

 

 

21

.. confval:: coverage_ignore_modules

 

22

 

 

23

.. confval:: coverage_ignore_functions

 

24

 

 

25

.. confval:: coverage_ignore_classes

 

26

 

 

27

.. confval:: coverage_c_path

 

28

 

 

29

.. confval:: coverage_c_regexes

 

30

 

 

31

.. confval:: coverage_ignore_c_items

 

32

 

 

33

.. confval:: coverage_write_headline

 

34

 

 

35

   Set to ``False`` to not write headlines.

 

36

 

 

37

   .. versionadded:: 1.1

 

38

 

 

39

.. confval:: coverage_skip_undoc_in_source

 

40

 

 

41

   Skip objects that are not documented in the source with a docstring.

 

42

   ``False`` by default.

 

43

 

 

44

   .. versionadded:: 1.1

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1