class documentation
class ZopeInterfaceSystem(model.System): (source)
A system with only the zope interface extension enabled.
Class Variable | extensions |
List of extensions. |
Inherited from System
:
Method | __init__ |
Undocumented |
Method | add |
Undocumented |
Method | add |
Add object to the system. |
Method | add |
Undocumented |
Method | analyze |
Undocumented |
Method | fetch |
Download and parse intersphinx inventories based on configuration. |
Method | find |
Look up an object using a potentially outdated full name. |
Method | get |
Undocumented |
Method | handle |
This is called when we see two objects with the same .fullName(), for example: |
Method | introspect |
Undocumented |
Method | msg |
Log a message. pydoctor's logging system is bit messy. |
Method | objects |
Iterate over all instances of cls present in the system. |
Method | obj |
Undocumented |
Method | post |
Called when there are no more unprocessed modules. |
Method | privacy |
Undocumented |
Method | process |
Undocumented |
Method | process |
Undocumented |
Method | progress |
Undocumented |
Method | set |
Undocumented |
Class Variable | custom |
Additional list of extensions to load alongside default extensions. |
Class Variable | default |
Undocumented |
Class Variable | show |
What kind of attributes we should display the value for? |
Class Variable | system |
Undocumented |
Instance Variable | allobjects |
Undocumented |
Instance Variable | buildtime |
Undocumented |
Instance Variable | intersphinx |
Undocumented |
Instance Variable | module |
Undocumented |
Instance Variable | needsnl |
Undocumented |
Instance Variable | once |
Undocumented |
Instance Variable | options |
Undocumented |
Instance Variable | parse |
Dict from the name of the thing we're rendering (section) to the FullNames of objects for which the rendereable elements failed to parse. Typically the renderable element is the docstring, but it can be the decorators, parameter default values or any other colorized AST. |
Instance Variable | processing |
Undocumented |
Instance Variable | projectname |
Undocumented |
Instance Variable | rootobjects |
Undocumented |
Instance Variable | unprocessed |
Undocumented |
Instance Variable | verboselevel |
Undocumented |
Instance Variable | violations |
The number of docstring problems found. This is used to determine whether to fail the build when using the --warnings-as-errors option, so it should only be increased for problems that the user can fix. |
Property |
|
Undocumented |
Property |
|
Undocumented |
Property |
|
Undocumented |
Property |
|
Undocumented |
Property |
|
Undocumented |
Property | root |
The top-level package/module names in this system. |
Property | sourcebase |
Undocumented |
Method | _add |
First add the new module into the unprocessed_modules list. Handle eventual duplication of module names, and finally add the module to the system. |
Method | _handle |
This is called when two modules have the same name. |
Method | _introspect |
Undocumented |
Method | _remove |
Undocumented |
Instance Variable | _astbuilder |
Undocumented |
Instance Variable | _factory |
Undocumented |
Instance Variable | _post |
Undocumented |
Instance Variable | _privacy |
Undocumented |
overrides
pydoctor.model.System.extensions
List of extensions.
By default, all built-in pydoctor extensions will be loaded. Override this value to cherry-pick extensions.