pydoctor.templatewriter.pages.CommonPage

class documentation

class CommonPage(Page): (source)

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

View In Hierarchy

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 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 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): (source)
overrides pydoctor.templatewriter.pages.Page.__init__
overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

Parameters
ob:model.DocumentableUndocumented
template_lookup:TemplateLookupUndocumented
docgetter:Optional[util.DocGetter]Undocumented
@renderer
def baseTables(self, request, tag): (source)
overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

Parameters
request:objectUndocumented
tag:TagUndocumented
Returns
FlattenableUndocumented
def category(self): (source)

Undocumented

Returns
strUndocumented
def childlist(self): (source)

Undocumented

Returns
List[Union[AttributeChild, FunctionChild]]Undocumented
def children(self): (source)
overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

Returns
Sequence[model.Documentable]Undocumented
@renderer
def deprecated(self, request, tag): (source)

Undocumented

Parameters
request:objectUndocumented
tag:TagUndocumented
Returns
FlattenableUndocumented
def docstring(self): (source)

Undocumented

Returns
FlattenableUndocumented
def extras(self): (source)
overridden in pydoctor.templatewriter.pages.ClassPage, pydoctor.templatewriter.pages.ModulePage

Undocumented

Returns
List[Tag]Undocumented
def functionBody(self, ob): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
FlattenableUndocumented
def heading(self): (source)

Undocumented

Returns
TagUndocumented
@renderer
def inhierarchy(self, request, tag): (source)
overridden in pydoctor.templatewriter.pages.ClassPage

Undocumented

Parameters
request:objectUndocumented
tag:TagUndocumented
Returns
FlattenableUndocumented
@renderer
def maindivclass(self, request, tag): (source)

Undocumented

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
strUndocumented
def mainTable(self): (source)

Undocumented

Returns
FlattenableUndocumented
def methods(self): (source)
overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

Returns
Sequence[model.Documentable]Undocumented
def namespace(self, obj): (source)

Undocumented

Parameters
obj:model.DocumentableUndocumented
Returns
List[Union[Tag, str]]Undocumented
def objectExtras(self, ob): (source)
overridden in pydoctor.templatewriter.pages.ClassPage

Flatten each model.Documentable.extra_info list item.

Parameters
ob:model.DocumentableUndocumented
Returns
List[Tag]Undocumented
def packageInitTable(self): (source)
overridden in pydoctor.templatewriter.pages.PackagePage

Undocumented

Returns
FlattenableUndocumented
@renderer
def sidebarcontainer(self, request, tag): (source)

Undocumented

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
Union[Tag, str]Undocumented
@renderer
def source(self, request, tag): (source)

Undocumented

Parameters
request:objectUndocumented
tag:TagUndocumented
Returns
FlattenableUndocumented
def title(self): (source)
overrides pydoctor.templatewriter.pages.Page.title

Undocumented

Returns
strUndocumented
filename: str = (source)

Undocumented

docgetter = (source)

Undocumented

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

Undocumented

@property
page_url: str = (source)

Undocumented

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

Undocumented