Package epydoc :: Module docbuilder :: Class BuildOptions

Class BuildOptions

Holds the parameters for a documentation building process.

Instance Methods

__init__(self, introspect=True, parse=True, exclude_introspect=None, exclude_parse=None, add_submodules=True)

source code
call graph

must_introspect(self, name)
Return True if a module is to be introsepcted with the current settings. source code
call graph

must_parse(self, name)
Return True if a module is to be parsed with the current settings. source code
call graph

bool

_matches_filter(self, name, regexp)
Test if a module name matches a pattern.

source code
call graph

Method Details

Return True if a module is to be introsepcted with the current settings.

Parameters:

Return True if a module is to be parsed with the current settings.

Parameters:

Test if a module name matches a pattern.

Parameters:

name (DottedName or str) - The name of the module to test
regexp (pattern) - The pattern object to match name against. If None, return False

Returns: bool

True if name in dotted format matches regexp, else False