pydoctor.templatewriter.summary

module documentation

Classes that generate the summary pages.
Class ​Class​Index​Page Undocumented
Class ​Index​Page Undocumented
Class ​Letter​Element Undocumented
Class ​Module​Index​Page Undocumented
Class ​Name​Index​Page Undocumented
Class ​Undocumented​Summary​Page Undocumented
Function find​Root​Classes Undocumented
Function hasdocstring Undocumented
Function is​Class​Node​Private Are a class and all its subclasses are private?
Function is​Private Is the object itself private or does it live in a private context?
Function module​Summary Undocumented
Function subclasses​From Undocumented
Constant summarypages Undocumented
Function ​_lckey Undocumented
def findRootClasses(system):

Undocumented

Parameters
system:model.SystemUndocumented
Returns
Sequence[Tuple[str, Union[model.Class, Sequence[model.Class]]]]Undocumented
def hasdocstring(ob):

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
boolUndocumented
def isClassNodePrivate(cls):
Are a class and all its subclasses are private?
Returns
boolUndocumented
def isPrivate(obj):
Is the object itself private or does it live in a private context?
Parameters
obj:model.DocumentableUndocumented
Returns
boolUndocumented
def moduleSummary(module, page_url):

Undocumented

Parameters
module:model.ModuleUndocumented
page​_url:strUndocumented
Returns
TagUndocumented
def subclassesFrom(hostsystem, cls, anchors, page_url):

Undocumented

Parameters
hostsystem:model.SystemUndocumented
cls:model.ClassUndocumented
anchors:MutableSet[str]Undocumented
page​_url:strUndocumented
Returns
TagUndocumented
summarypages: Iterable[Type[Page]] =

Undocumented

Value
[ModuleIndexPage,
 ClassIndexPage,
 IndexPage,
 NameIndexPage,
 UndocumentedSummaryPage]
def _lckey(x):

Undocumented

Parameters
x:model.DocumentableUndocumented
Returns
Tuple[str, str]Undocumented