pydoctor.templatewriter.pages.CommonPage

class documentation

class CommonPage(Page):

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

Undocumented

Method	`__init__`	Undocumented
Method	`baseTables`	Undocumented
Method	`category`	Undocumented
Method	`childlist`	Undocumented
Method	`children`	Undocumented
Method	`deprecated`	Undocumented
Method	`docstring`	Undocumented
Method	`extras`	Undocumented
Method	`functionBody`	Undocumented
Method	`functionExtras`	Undocumented
Method	`heading`	Undocumented
Method	`inhierarchy`	Undocumented
Method	`mainTable`	Undocumented
Method	`methods`	Undocumented
Method	`namespace`	Undocumented
Method	`packageInitTable`	Undocumented
Method	`source`	Undocumented
Method	`title`	Undocumented
Class Variable	`filename`	Undocumented
Instance Variable	`docgetter`	Undocumented
Instance Variable	`ob`	Undocumented
Property	`page_url`	Undocumented
Property	`slot_map`	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, template_lookup, docgetter=None):

overrides pydoctor.templatewriter.pages.Page.__init__

overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

Parameters
ob:`model.Documentable`	Undocumented
template_lookup:`TemplateLookup`	Undocumented
docgetter:`Optional[DocGetter]`	Undocumented

@renderer
def baseTables(self, request, tag):

overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

Parameters
request:`object`	Undocumented
tag:`Tag`	Undocumented
Returns
`Flattenable`	Undocumented

def category(self):

Undocumented

Returns
`str`	Undocumented

def childlist(self):

Undocumented

Returns
`List[Union[AttributeChild, FunctionChild]]`	Undocumented

def children(self):

overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

Returns
`Sequence[model.Documentable]`	Undocumented

@renderer
def deprecated(self, request, tag):

Undocumented

Parameters
request:`object`	Undocumented
tag:`Tag`	Undocumented
Returns
`Flattenable`	Undocumented

def docstring(self):

Undocumented

Returns
`Flattenable`	Undocumented

def extras(self):

overridden in pydoctor.templatewriter.pages.ClassPage, pydoctor.templatewriter.pages.ModulePage

Undocumented

Returns
`List[Flattenable]`	Undocumented

def functionBody(self, ob):

Undocumented

Parameters
ob:`model.Documentable`	Undocumented
Returns
`Flattenable`	Undocumented

def functionExtras(self, ob):

overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

Parameters
ob:`model.Documentable`	Undocumented
Returns
`List[Flattenable]`	Undocumented

def heading(self):

Undocumented

Returns
`Tag`	Undocumented

@renderer
def inhierarchy(self, request, tag):

overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

Parameters
request:`object`	Undocumented
tag:`Tag`	Undocumented
Returns
`Flattenable`	Undocumented

def mainTable(self):

Undocumented

Returns
`Flattenable`	Undocumented

def methods(self):

overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

Returns
`Sequence[model.Documentable]`	Undocumented

def namespace(self, obj):

Undocumented

Parameters
obj:`model.Documentable`	Undocumented
Returns
`List[Union[Tag, str]]`	Undocumented

def packageInitTable(self):

overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

Returns
`Flattenable`	Undocumented

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

Undocumented

Parameters
request:`object`	Undocumented
tag:`Tag`	Undocumented
Returns
`Flattenable`	Undocumented

def title(self):

overrides pydoctor.templatewriter.pages.Page.title

Undocumented

Returns
`str`	Undocumented

filename: str =

Undocumented

docgetter =

Undocumented

ob =

overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

@property
page_url: str =

Undocumented

@property
slot_map: Dict[str, Flattenable] =

overrides pydoctor.templatewriter.pages.Page.slot_map

Undocumented