pydoctor.templatewriter.pages.sidebar.SideBar

class documentation

class SideBar(TemplateElement): (source)

Constructor: SideBar(ob, template_lookup)

View In Hierarchy

Sidebar.

Contains:

  • the object docstring table of contents if titles are defined
  • for classes:
    • information about the contents of the current class and parent module/package.
  • for modules/packages:
    • information about the contents of the module and parent package.
Method __init__ Undocumented
Method sections Sections are SideBarSection elements.
Class Variable filename Undocumented
Instance Variable ob Undocumented
Instance Variable template_lookup Undocumented

Inherited from TemplateElement:

Class Method lookup_loader Lookup the element ITemplateLoader with the TemplateLookup.
def __init__(self, ob: Documentable, template_lookup: TemplateLookup): (source)

Undocumented

@renderer
def sections(self, request: IRequest, tag: Tag) -> Iterator[SideBarSection]: (source)

Sections are SideBarSection elements.

filename: str = (source)

Undocumented

ob = (source)

Undocumented

template_lookup = (source)

Undocumented