Getting Started

First, install it by (requires python 3.6+):

pip install docscov

You need to use Doxygen to generate XML data about the source files. To do that, add the following to your Doxygen configuration: (not needed if you’re using tools like Breathe or Exhale, you should have this already)

GENERATE_XML = YES

This will generate XML data about source files. Now just add docscov to your Sphinx extensions and add the following to your conf.py:

docscov_config = {
    "xml_dir": "<path to generated XML by Doxygen>"
}

It’ll places a JSON file inside built documentations, which can be used with Shields to make a dynamic badge, updated each time documentations are built.

Configurable options

You can configure DocsCov with the following options:

xml_dir:

Value type: str

Description: Path to Doxygen XML output

root_dir:

Value type: str

Description: Path to process relative directories.

Notes: Optional.

Default: '.'

badge_label:

Value type: str

Description: The label of badge.

Notes: Optional.

Default: 'docscov'

scope:

Value type: list

Description: Coverage scope. Possible values of elements:

• public: Include public members of classes

• protected: Include protected members of classes

• private: Include private members of classes

• all: All of above

Notes: Optional.

Default: ['all']

kind:

Value type: list

Description: Kind of definitions to include in coverage. Possible values of elements:

• class

• define

• enum

• enumvalue

• file

• friend

• function

• namespace

• page

• signal

• slot

• struct

• typedef

• union

• variable

• all: All of above

Notes: Optional.

Default: ['all']