pydoctor.templatewriter.pages.sidebar.SideBarSection

class documentation

class SideBarSection(Element): (source)

View In Hierarchy

Main sidebar section.

The sidebar typically contains two SideBarSection: one for the documented object and one for it's parent. Root modules have only one section.

Method __init__ Undocumented
Method content Undocumented
Method description Short description of the sidebar section.
Method kind Undocumented
Method name Craft a <code><a> block for the title with custom description when hovering.
Instance Variable documented_ob Undocumented
Instance Variable ob Undocumented
Instance Variable template_lookup Undocumented
Instance Variable _represents_documented_ob Undocumented
def __init__(self, ob, documented_ob, loader, template_lookup): (source)

Undocumented

Parameters
ob:DocumentableUndocumented
documented_ob:DocumentableUndocumented
loader:ITemplateLoaderUndocumented
template_lookup:TemplateLookupUndocumented
@renderer
def content(self, request, tag): (source)

Undocumented

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
ObjContentUndocumented
def description(self): (source)

Short description of the sidebar section.

Returns
strUndocumented
@renderer
def kind(self, request, tag): (source)

Undocumented

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
strUndocumented
@renderer
def name(self, request, tag): (source)

Craft a <code><a> block for the title with custom description when hovering.

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
TagUndocumented
documented_ob = (source)

Undocumented

ob = (source)

Undocumented

template_lookup = (source)

Undocumented

_represents_documented_ob = (source)

Undocumented