pydoctor.templatewriter.pages.sidebar.SideBarSection

class documentation

class SideBarSection(Element): (source)

Constructor: SideBarSection(ob, documented_ob, loader, template_lookup)

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: Documentable, documented_ob: Documentable, loader: ITemplateLoader, template_lookup: TemplateLookup): (source)

Undocumented

def content(self, request: IRequest, tag: Tag) -> ObjContent: (source)

Undocumented

def description(self) -> str: (source)

Short description of the sidebar section.

def kind(self, request: IRequest, tag: Tag) -> str: (source)

Undocumented

def name(self, request: IRequest, tag: Tag) -> Tag: (source)

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

documented_ob = (source)

Undocumented

ob = (source)

Undocumented

template_lookup = (source)

Undocumented

_represents_documented_ob = (source)

Undocumented