pydoctor.templatewriter.pages.CommonPage

class documentation

class CommonPage(Page): (source)

Known subclasses: pydoctor.templatewriter.pages.ClassPage, pydoctor.templatewriter.pages.ModulePage

Constructor: CommonPage(ob, template_lookup, docgetter)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method baseTables Undocumented
Method category Undocumented
Method childlist Undocumented
Method children Undocumented
Method docstring Undocumented
Method extras Undocumented
Method functionBody Undocumented
Method heading Undocumented
Method inhierarchy Undocumented
Method maindivclass Undocumented
Method mainTable Undocumented
Method methods Undocumented
Method namespace Undocumented
Method objectExtras Flatten each model.Documentable.extra_info list item.
Method packageInitTable Undocumented
Method sidebarcontainer Undocumented
Method title Undocumented
Class Variable filename Undocumented
Instance Variable docgetter Undocumented
Instance Variable ob Undocumented
Property page_url The relative page url
Property slot_map Undocumented
Instance Variable _order Undocumented

Inherited from Page:

Method footer Undocumented
Method head Undocumented
Method header Undocumented
Method nav Undocumented
Method render Undocumented
Method subheader Undocumented
Instance Variable system Undocumented
Instance Variable template_lookup Undocumented

Inherited from TemplateElement (via Page):

Class Method lookup_loader Lookup the element ITemplateLoader with the TemplateLookup.
def __init__(self, ob: model.Documentable, template_lookup: TemplateLookup, docgetter: util.DocGetter | None = None): (source)
overrides pydoctor.templatewriter.pages.Page.__init__
overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

def baseTables(self, request: object, tag: Tag) -> Flattenable: (source)
overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

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

Undocumented

def childlist(self) -> list[AttributeChild | FunctionChild]: (source)

Undocumented

def children(self) -> Sequence[model.Documentable]: (source)
overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

def docstring(self) -> Flattenable: (source)

Undocumented

def extras(self) -> list[Flattenable]: (source)
overridden in pydoctor.templatewriter.pages.ClassPage, pydoctor.templatewriter.pages.ModulePage

Undocumented

def functionBody(self, ob: model.Documentable) -> Flattenable: (source)

Undocumented

def heading(self) -> Tag: (source)

Undocumented

def inhierarchy(self, request: object, tag: Tag) -> Flattenable: (source)
overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

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

Undocumented

def mainTable(self) -> Flattenable: (source)

Undocumented

def methods(self) -> Sequence[model.Documentable]: (source)
overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

def namespace(self, obj: model.Documentable) -> list[Tag | str]: (source)

Undocumented

def objectExtras(self, ob: model.Documentable) -> list[Flattenable]: (source)
overridden in pydoctor.templatewriter.pages.ClassPage

Flatten each model.Documentable.extra_info list item.

def packageInitTable(self) -> Flattenable: (source)
overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

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

Undocumented

def title(self) -> str: (source)
overrides pydoctor.templatewriter.pages.Page.title

Undocumented

filename: str = (source)

Undocumented

docgetter = (source)

Undocumented

ob: model.Documentable = (source)
overridden in pydoctor.templatewriter.pages.ClassPage, pydoctor.templatewriter.pages.ModulePage

Undocumented

page_url: str = (source)
overrides pydoctor.templatewriter.pages.Page.page_url

The relative page url

slot_map: dict[str, Flattenable] = (source)
overrides pydoctor.templatewriter.pages.Page.slot_map

Undocumented

_order = (source)

Undocumented