pydoctor.templatewriter.pages.sidebar.ObjContent

class documentation

class ObjContent(Element): (source)

Object content displayed on the sidebar.

Each SideBarSection object uses one of these in the SideBarSection.content renderer. This object is also used to represent the contents of nested expandable items.

Composed by ContentList elements.

Method	`__init__`	Undocumented
Method	`classes`	Undocumented
Method	`classesTitle`	Undocumented
Method	`docstringToc`	Undocumented
Method	`functions`	Undocumented
Method	`functionsTitle`	Undocumented
Method	`inheritedFunctions`	Undocumented
Method	`inheritedFunctionsTitle`	Undocumented
Method	`inheritedVariables`	Undocumented
Method	`inheritedVariablesTitle`	Undocumented
Method	`subModules`	Undocumented
Method	`subModulesTitle`	Undocumented
Method	`variables`	Undocumented
Method	`variablesTitle`	Undocumented
Instance Variable	`classList`	Undocumented
Instance Variable	`documented_ob`	Undocumented
Instance Variable	`functionList`	Undocumented
Instance Variable	`inheritedFunctionList`	Undocumented
Instance Variable	`inheritedVariableList`	Undocumented
Instance Variable	`ob`	Undocumented
Instance Variable	`subModuleList`	Undocumented
Instance Variable	`template_lookup`	Undocumented
Instance Variable	`variableList`	Undocumented
Property	`has_contents`	Undocumented
Method	`_children`	Compute the children of this object.
Method	`_getContentList`	Undocumented
Method	`_isExpandable`	Should the list items be expandable?
Instance Variable	`_depth`	Undocumented
Instance Variable	`_level`	Undocumented

def __init__(self, loader, ob, documented_ob, template_lookup, depth, level=0): (source) ¶

Undocumented

Parameters
loader:`ITemplateLoader`	Undocumented
ob:`Documentable`	Undocumented
documented_ob:`Documentable`	Undocumented
template_lookup:`TemplateLookup`	Undocumented
depth:`int`	Undocumented
level:`int`	Undocumented

@renderer
def classes(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Element, str]`	Undocumented

@renderer
def classesTitle(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Tag, str]`	Undocumented

@renderer
def docstringToc(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Tag, str]`	Undocumented

@renderer
def functions(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Element, str]`	Undocumented

@renderer
def functionsTitle(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Tag, str]`	Undocumented

@renderer
def inheritedFunctions(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Element, str]`	Undocumented

@renderer
def inheritedFunctionsTitle(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Tag, str]`	Undocumented

@renderer
def inheritedVariables(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Element, str]`	Undocumented

@renderer
def inheritedVariablesTitle(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Tag, str]`	Undocumented

@renderer
def subModules(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Element, str]`	Undocumented

@renderer
def subModulesTitle(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Tag, str]`	Undocumented

@renderer
def variables(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Element, str]`	Undocumented

@renderer
def variablesTitle(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`Union[Tag, str]`	Undocumented

classList = (source) ¶

Undocumented

documented_ob = (source) ¶

Undocumented

functionList = (source) ¶

Undocumented

inheritedFunctionList = (source) ¶

Undocumented

inheritedVariableList = (source) ¶

Undocumented

ob = (source) ¶

Undocumented

subModuleList = (source) ¶

Undocumented

template_lookup = (source) ¶

Undocumented

variableList = (source) ¶

Undocumented

@property
has_contents: bool = (source) ¶

Undocumented

def _children(self, inherited=False): (source) ¶

Compute the children of this object.

Parameters
inherited:`bool`	Undocumented
Returns
`List[Documentable]`	Undocumented

def _getContentList(self, children, type_): (source) ¶

Undocumented

Parameters
children:`Sequence[Documentable]`	Undocumented
type_:`Type[Documentable]`	Undocumented
Returns
`Optional[ContentList]`	Undocumented

def _isExpandable(self, list_type): (source) ¶

Should the list items be expandable?

Parameters
list_type:`Type[Documentable]`	Undocumented
Returns
`bool`	Undocumented

_depth = (source) ¶

Undocumented

_level = (source) ¶

Undocumented