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.IndexPage, pydoctor.templatewriter.summary.ModuleIndexPage, pydoctor.templatewriter.summary.NameIndexPage, pydoctor.templatewriter.summary.UndocumentedSummaryPage

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	`slot_map`	Undocumented

Inherited from TemplateElement:

Class Method lookup_loader Lookup the element ITemplateLoader with the TemplateLookup.

def __init__(self, system, template_lookup, loader=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

Parameters
system:`model.System`	Undocumented
template_lookup:`TemplateLookup`	Undocumented
loader:`Optional[ITemplateLoader]`	Undocumented

@renderer
def footer(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`IRenderable`	Undocumented

@renderer
def head(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`IRenderable`	Undocumented

@renderer
def header(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`IRenderable`	Undocumented

@renderer
def nav(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`IRenderable`	Undocumented

def render(self, request): (source) ¶

Undocumented

Parameters
request:`Optional[IRequest]`	Undocumented
Returns
`Tag`	Undocumented

@renderer
def subheader(self, request, tag): (source) ¶

Undocumented

Parameters
request:`IRequest`	Undocumented
tag:`Tag`	Undocumented
Returns
`IRenderable`	Undocumented

@abc.abstractmethod
def title(self): (source) ¶

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

Undocumented

Returns
`str`	Undocumented

system = (source) ¶

Undocumented

template_lookup = (source) ¶

Undocumented

@property
slot_map: Dict[str, Flattenable] = (source) ¶

overridden in pydoctor.templatewriter.pages.CommonPage

Undocumented