pydoctor.templatewriter.summary.HelpPage

class documentation

class HelpPage(Page): (source)

Constructor: HelpPage(system, template_lookup, loader)

View In Hierarchy

Undocumented

Method heading Undocumented
Method helpcontent Undocumented
Method title Undocumented
Constant RST_SOURCE_TEMPLATE Undocumented
Class Variable filename Undocumented

Inherited from Page:

Method __init__ Undocumented
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
Property page_url The relative page url
Property slot_map Undocumented

Inherited from TemplateElement (via Page):

Class Method lookup_loader Lookup the element ITemplateLoader with the TemplateLookup.
def heading(self, request: object, tag: Tag) -> Tag: (source)

Undocumented

def helpcontent(self, request: object, tag: Tag) -> Tag: (source)

Undocumented

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

Undocumented

RST_SOURCE_TEMPLATE = (source)

Undocumented

Value
Template('''
    Navigation
    ----------

    There is one page per class, module and package. 
    Each page present summary table(s) which feature the members of the object.

...
filename: str = (source)

Undocumented