pydoctor.templatewriter.pages.sidebar.ObjContent

class documentation

class ObjContent(Element): (source)

Constructor: ObjContent(loader, ob, documented_ob, template_lookup, ...)

View In Hierarchy

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
Instance Variable _order Undocumented
def __init__(self, loader: ITemplateLoader, ob: Documentable, documented_ob: Documentable, template_lookup: TemplateLookup, depth: int, level: int = 0): (source)

Undocumented

@renderer
def classes(self, request: IRequest, tag: Tag) -> Element | str: (source)

Undocumented

@renderer
def classesTitle(self, request: IRequest, tag: Tag) -> Tag | str: (source)

Undocumented

@renderer
def docstringToc(self, request: IRequest, tag: Tag) -> Tag | str: (source)

Undocumented

@renderer
def functions(self, request: IRequest, tag: Tag) -> Element | str: (source)

Undocumented

@renderer
def functionsTitle(self, request: IRequest, tag: Tag) -> Tag | str: (source)

Undocumented

@renderer
def inheritedFunctions(self, request: IRequest, tag: Tag) -> Element | str: (source)

Undocumented

@renderer
def inheritedFunctionsTitle(self, request: IRequest, tag: Tag) -> Tag | str: (source)

Undocumented

@renderer
def inheritedVariables(self, request: IRequest, tag: Tag) -> Element | str: (source)

Undocumented

@renderer
def inheritedVariablesTitle(self, request: IRequest, tag: Tag) -> Tag | str: (source)

Undocumented

@renderer
def subModules(self, request: IRequest, tag: Tag) -> Element | str: (source)

Undocumented

@renderer
def subModulesTitle(self, request: IRequest, tag: Tag) -> Tag | str: (source)

Undocumented

@renderer
def variables(self, request: IRequest, tag: Tag) -> Element | str: (source)

Undocumented

@renderer
def variablesTitle(self, request: IRequest, tag: Tag) -> Tag | str: (source)

Undocumented

classList = (source)

Undocumented

documented_ob = (source)

Undocumented

functionList = (source)

Undocumented

inheritedFunctionList: ContentList | None = (source)

Undocumented

inheritedVariableList: ContentList | None = (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: bool = False) -> list[Documentable]: (source)

Compute the children of this object.

def _getContentList(self, children: Sequence[Documentable], type_: type[Documentable]) -> ContentList | None: (source)

Undocumented

def _isExpandable(self, list_type: type[Documentable]) -> bool: (source)

Should the list items be expandable?

_depth = (source)

Undocumented

_level = (source)

Undocumented

_order = (source)

Undocumented