package documentation
Pydoctor's extension system.
An extension can be composed by mixin classes, AST builder visitor extensions and post processors.
Module | attrs |
Support for attrs . |
Module | deprecate |
Support for twisted.python.deprecate . |
Module | zopeinterface |
Support for Zope interfaces. |
From __init__.py
:
Class |
|
Base class for mixins applied to model.Attribute objects. |
Class |
|
Base class for mixins applied to model.Class , model.Module and model.Package objects. |
Class |
|
Base class for mixins applied to model.Class objects. |
Class |
|
Base class for mixins applied to all model.Documentable objects. |
Class |
|
The extension registrar class provides utilites to register an extension's components. |
Class |
|
Base class for mixins applied to model.Function objects. |
Class |
|
Base class for mixins applied to model.Function and model.Attribute objects. |
Class |
|
Base class for mixins applied to model.Module objects. |
Class |
|
Base class to extend the astbuilder.ModuleVistor . |
Class |
|
Base class for mixins applied to model.Package objects. |
Function | get |
Get the full names of all the pydoctor extension modules. |
Function | load |
Load the pydoctor extension module into the system. |
Type Alias |
|
Undocumented |
Function | _get |
Transform a list of mixins classes to a dict from the concrete class name to the mixins that must be applied to it. This relies on the fact that mixins shoud extend one of the base mixin classes in pydoctor.extensions ... |
Function | _get |
Will look for the special function setup_pydoctor_extension in the provided module. |
Function | _get |
Undocumented |
Function | _importlib |
Return an iterable of entries in package. |
Function | _importlib |
True if name is a resource inside package. |
Variable | _mixin |
Undocumented |
Will look for the special function setup_pydoctor_extension in the provided module.
Parameters | |
module:str | Undocumented |
Returns | |
Callable[ | a tuple(str, callable): extension module name, setup_pydoctor_extension() function. |
Raises | |
AssertionError | if module do not provide a valid setup_pydoctor_extension() function. |
ModuleNotFoundError | if module is not found. |
Transform a list of mixins classes to a dict from the concrete class name to the mixins that must be applied to it. This relies on the fact that mixins shoud extend one of the base mixin classes in pydoctor.extensions
module.
Parameters | |
*mixins:Type[ | Undocumented |
Returns | |
Dict[ | Undocumented |
Raises | |
AssertionError | If a mixin does not extends any of the provided base mixin classes. |
Load the pydoctor extension module into the system.
Parameters | |
system:model.System | Undocumented |
mod:str | Undocumented |