pydoctor.model.Package

Inherited from Module:

Method	docformat.setter	Undocumented
Method	setup	Undocumented
Method	submodules	Returns an iterator over the visible submodules.
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	privacyClass	How visible this object should be.
Method	_localNameToFullName	Undocumented
Instance Variable	_docformat	Undocumented
Instance Variable	_is_c_module	Whether this module is a C-extension.
Instance Variable	_py_mod	The live module if the module was built from introspection.
Instance Variable	_py_string	The module string if the module was built from text.

Inherited from CanContainImportsDocumentable (via Module):

Method	isNameDefined	Is the given name defined in the globals/locals of self-context? Only the first name of a dotted name is checked.
Instance Variable	_localNameToFullName_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	expandAnnotationName	Like expandName but gives precedence to the module scope when a name is defined both in the current scope and the module scope.
Method	expandName	Return a fully qualified name for the possibly-dotted `name`.
Method	fullName	Undocumented
Method	reparent	Undocumented
Method	report	Log an error or warning about this documentable object.
Method	resolveName	Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor.
Method	setDocstring	Undocumented
Method	setLineNumber	Save the linenumber of this object.
Class Variable	kind	Page location where we are documented.
Class Variable	parsed_docstring	Undocumented
Class Variable	parsed_summary	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	extra_info	A list to store extra informations about this documentable, as ParsedDocstring.
Instance Variable	linenumber	Undocumented
Instance Variable	name	Undocumented
Instance Variable	parent	Undocumented
Instance Variable	parentMod	Undocumented
Instance Variable	source_path	Undocumented
Instance Variable	sourceHref	Undocumented
Instance Variable	system	The system the object is part of.
Property	description	A string describing our source location to the user.
Property	docstring_linker	Returns an instance of DocstringLinker suitable for resolving names in the context of the object.
Property	doctarget	Undocumented
Property	isPrivate	Is this object considered private API?
Property	isVisible	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	_linker	Undocumented