pydoctor.templatewriter.summary

module documentation
(source)

Classes that generate the summary pages.

Class ClassIndexPage Undocumented
Class IndexPage Undocumented
Class LetterElement Undocumented
Class ModuleIndexPage Undocumented
Class NameIndexPage Undocumented
Class UndocumentedSummaryPage Undocumented
Function findRootClasses Undocumented
Function hasdocstring Undocumented
Function isClassNodePrivate Are a class and all its subclasses are private?
Function isPrivate Is the object itself private or does it live in a private context?
Function moduleSummary Undocumented
Function subclassesFrom Undocumented
Function summaryPages Undocumented
Function _lckey Undocumented
def findRootClasses(system): (source)

Undocumented

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

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
boolUndocumented
def isClassNodePrivate(cls): (source)

Are a class and all its subclasses are private?

Parameters
cls:model.ClassUndocumented
Returns
boolUndocumented
def isPrivate(obj): (source)

Is the object itself private or does it live in a private context?

Parameters
obj:model.DocumentableUndocumented
Returns
boolUndocumented
def moduleSummary(module, page_url): (source)

Undocumented

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

Undocumented

Parameters
hostsystem:model.SystemUndocumented
cls:model.ClassUndocumented
anchors:MutableSet[str]Undocumented
page_url:strUndocumented
Returns
TagUndocumented
def summaryPages(system): (source)

Undocumented

Parameters
system:model.SystemUndocumented
Returns
Iterable[Type[Page]]Undocumented
def _lckey(x): (source)

Undocumented

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