pydoctor.templatewriter.summary

module documentation

(source)

Classes that generate the summary pages.

Class	`ClassIndexPage`	Undocumented
Class	`HelpPage`	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: model.System) -> Sequence[tuple[str, model.Class | Sequence[model.Class]]]: (source) ¶

Undocumented

def hasdocstring(ob: model.Documentable) -> bool: (source) ¶

Undocumented

def isClassNodePrivate(cls: model.Class) -> bool: (source) ¶

Are a class and all its subclasses are private?

def isPrivate(obj: model.Documentable) -> bool: (source) ¶

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

def moduleSummary(module: model.Module, page_url: str) -> Tag: (source) ¶

Undocumented

def subclassesFrom(hostsystem: model.System, cls: model.Class, anchors: MutableSet[str], page_url: str) -> Tag: (source) ¶

Undocumented

def summaryPages(system: model.System) -> Iterable[type[Page]]: (source) ¶

Undocumented

def _lckey(x: model.Documentable) -> tuple[str, str]: (source) ¶

Undocumented