pydoctor.templatewriter.pages.Page

class documentation

class Page(TemplateElement): (source)

Known subclasses: pydoctor.templatewriter.pages.CommonPage, pydoctor.templatewriter.search.AllDocuments, pydoctor.templatewriter.summary.ClassIndexPage, pydoctor.templatewriter.summary.HelpPage, pydoctor.templatewriter.summary.IndexPage, pydoctor.templatewriter.summary.ModuleIndexPage, pydoctor.templatewriter.summary.NameIndexPage, pydoctor.templatewriter.summary.UndocumentedSummaryPage

Constructor: Page(system, template_lookup, loader)

View In Hierarchy

Abstract base class for output pages.

Defines special HTML placeholders that are designed to be overriden by users: "header.html", "subheader.html" and "footer.html".

Method	`__init__`	Undocumented
Method	`footer`	Undocumented
Method	`head`	Undocumented
Method	`header`	Undocumented
Method	`nav`	Undocumented
Method	`render`	Undocumented
Method	`subheader`	Undocumented
Method	`title`	Undocumented
Instance Variable	`system`	Undocumented
Instance Variable	`template_lookup`	Undocumented
Property	`page_url`	The relative page url
Property	`slot_map`	Undocumented

Inherited from TemplateElement:

Class Method lookup_loader Lookup the element ITemplateLoader with the TemplateLookup.

def __init__(self, system: model.System, template_lookup: TemplateLookup, loader: ITemplateLoader | None = None): (source) ¶

overridden in pydoctor.templatewriter.pages.CommonPage, pydoctor.templatewriter.summary.ClassIndexPage, pydoctor.templatewriter.summary.ModuleIndexPage, pydoctor.templatewriter.summary.NameIndexPage, pydoctor.templatewriter.summary.UndocumentedSummaryPage

Undocumented

@renderer

def footer(self, request: IRequest, tag: Tag) -> IRenderable: (source) ¶

Undocumented

@renderer

def head(self, request: IRequest, tag: Tag) -> IRenderable: (source) ¶

Undocumented

@renderer

def header(self, request: IRequest, tag: Tag) -> IRenderable: (source) ¶

Undocumented

@renderer

def nav(self, request: IRequest, tag: Tag) -> IRenderable: (source) ¶

Undocumented

def render(self, request: IRequest | None) -> Tag: (source) ¶

Undocumented

@renderer

def subheader(self, request: IRequest, tag: Tag) -> IRenderable: (source) ¶

Undocumented

@abc.abstractmethod

def title(self) -> str: (source) ¶

overridden in pydoctor.templatewriter.pages.CommonPage, pydoctor.templatewriter.search.AllDocuments, pydoctor.templatewriter.summary.ClassIndexPage, pydoctor.templatewriter.summary.HelpPage, pydoctor.templatewriter.summary.IndexPage, pydoctor.templatewriter.summary.ModuleIndexPage, pydoctor.templatewriter.summary.NameIndexPage, pydoctor.templatewriter.summary.UndocumentedSummaryPage

Undocumented

system = (source) ¶

Undocumented

template_lookup = (source) ¶

Undocumented

@property

page_url: str = (source) ¶

overridden in pydoctor.templatewriter.pages.CommonPage

The relative page url

@property

slot_map: dict[str, Flattenable] = (source) ¶

overridden in pydoctor.templatewriter.pages.CommonPage

Undocumented