sphinx.ext.coverage

module documentation

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

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Class ​Coverage​Builder Evaluates coverage of code in the documentation.
Variable logger Undocumented
Function compile​_regex​_list Undocumented
Function setup Undocumented
Function write​_header Undocumented
logger =

Undocumented

def compile_regex_list(name, exps):

Undocumented

Parameters
name:strUndocumented
exps:strUndocumented
Returns
List[Pattern]Undocumented
def setup(app):

Undocumented

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

Undocumented

Parameters
f:IOUndocumented
text:strUndocumented
char:strUndocumented