pydoctor.model.SystemBuilder

class documentation

class SystemBuilder(ISystemBuilder): (source)

View In Hierarchy

This class is only an adapter for some System methods related to module building.

Method __init__ Create the builder.
Method addModule Add a module or package from file system path to the pydoctor system. If the path points to a directory, adds all submodules recursively.
Method addModuleString Add a module from text to the system.
Method buildModules Build the modules.
Instance Variable system Undocumented
Instance Variable _added Undocumented
def __init__(self, system): (source)
overrides pydoctor.model.ISystemBuilder.__init__

Create the builder.

Parameters
system:SystemUndocumented
def addModule(self, path, parent_name=None): (source)
overrides pydoctor.model.ISystemBuilder.addModule

Add a module or package from file system path to the pydoctor system. If the path points to a directory, adds all submodules recursively.

Parameters
path:PathUndocumented
parent_name:Optional[str]Undocumented
Raises
SystemBuildingErrorIf there is an error while adding the module/package.
def addModuleString(self, text, modname, parent_name=None, is_package=False): (source)
overrides pydoctor.model.ISystemBuilder.addModuleString

Add a module from text to the system.

Parameters
text:strUndocumented
modname:strUndocumented
parent_name:Optional[str]Undocumented
is_package:boolUndocumented
def buildModules(self): (source)
overrides pydoctor.model.ISystemBuilder.buildModules

Build the modules.

system = (source)

Undocumented

_added: Set[Path] = (source)

Undocumented