pydoctor.model.SystemBuilder

class documentation

class SystemBuilder(ISystemBuilder): (source)

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: System): (source) ¶

overrides pydoctor.model.ISystemBuilder.__init__

Create the builder.

def addModule(self, path: Path, parent_name: str | None = 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.

Raises
`SystemBuildingError`	If there is an error while adding the module/package.

def addModuleString(self, text: str, modname: str, parent_name: str | None = None, is_package: bool = False): (source) ¶

overrides pydoctor.model.ISystemBuilder.addModuleString

Add a module from text to the system.

overrides pydoctor.model.ISystemBuilder.buildModules

Build the modules.

Undocumented

Undocumented