class documentation

class Package(Module):

View In Hierarchy

Undocumented

Inherited from Module:

Method docformat.setter Undocumented
Method setup Undocumented
Instance Variable all Names listed in the __all__ variable of this module.
Property docformat The name of the format to be used for parsing docstrings in this module.
Property module This object's Module.
Property privacy​Class How visible this object should be.
Method _local​Name​To​Full​Name Undocumented
Instance Variable ​_docformat Undocumented

Inherited from CanContainImportsDocumentable (via Module):

Instance Variable _local​Name​To​Full​Name_map Undocumented

Inherited from Documentable (via Module, CanContainImportsDocumentable):

Method __init__ Undocumented
Method __repr__ Undocumented
Method docsources Objects that can be considered as a source of documentation.
Method expand​Name Return a fully qualified name for the possibly-dotted `name`.
Method full​Name Undocumented
Method reparent Undocumented
Method report Log an error or warning about this documentable object.
Method resolve​Name Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor.
Method set​Docstring Undocumented
Method set​Line​Number Undocumented
Class Variable kind Undocumented
Class Variable parsed​_docstring Undocumented
Class Variable parsed​_type Undocumented
Instance Variable contents Undocumented
Instance Variable docstring The object's docstring. But also see docsources.
Instance Variable docstring​_lineno Undocumented
Instance Variable linenumber Undocumented
Instance Variable name Undocumented
Instance Variable parent Undocumented
Instance Variable parent​Mod Undocumented
Instance Variable source​_path Undocumented
Instance Variable source​Href Undocumented
Instance Variable system The system the object is part of.
Property description A string describing our source location to the user.
Property doctarget Undocumented
Property is​Private Is this object considered private API?
Property is​Visible Is this object so private as to be not shown at all?
Property page​_object The documentable to which the page we're documented on belongs. For example methods are documented on the page of their class, functions are documented in their module's page etc.
Property url Relative URL at which the documentation for this Documentable can be found.
Method ​_handle​_reparenting​_post Undocumented
Method ​_handle​_reparenting​_pre Undocumented
Instance Variable ​_deprecated​_info Undocumented