sphinx.ext.coverage

module documentation
(source)

Check Python modules and C API for coverage. Mostly written by Josip Dzolonga for the Google Highly Open Participation contest.

Class CoverageBuilder Evaluates coverage of code in the documentation.
Function compile_regex_list Undocumented
Function setup Undocumented
Function write_header Undocumented
Variable logger Undocumented
def compile_regex_list(name, exps): (source)

Undocumented

Parameters
name:strUndocumented
exps:strUndocumented
Returns
list[re.Pattern[str]]Undocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
def write_header(f, text, char='-'): (source)

Undocumented

Parameters
f:IO[str]Undocumented
text:strUndocumented
char:strUndocumented
logger = (source)

Undocumented