pydoctor.templatewriter.pages

package documentation

The classes that turn Documentable instances into objects we can render.

Module	`attributechild`	Undocumented
Module	`functionchild`	Undocumented
Module	`table`	Undocumented

From __init__.py:

Class	`ClassPage`	Undocumented
Class	`CommonPage`	Undocumented
Class	`DocGetter`	`epydoc2stan` bridge.
Class	`Head`	Common metadata.
Class	`ModulePage`	Undocumented
Class	`Nav`	Common navigation header.
Class	`PackagePage`	Undocumented
Class	`Page`	Abstract base class for output pages.
Class	`ZopeInterfaceClassPage`	Undocumented
Function	`assembleList`	Undocumented
Function	`format_decorators`	Undocumented
Function	`format_signature`	Return a stan representation of a nicely-formatted source-like function signature for the given `Function`. Arguments default values are linked to the appropriate objects when possible.
Function	`nested_bases`	Undocumented
Function	`objects_order`	Function to use as the value of standard library's `sorted` function `key` argument such that the objects are sorted by: Privacy, Kind and Name.
Function	`overriding_subclasses`	Undocumented
Function	`unmasked_attrs`	Undocumented
Constant	`commonpages`	List all page classes: ties documentable class name with the page class used for rendering

def objects_order(o):

Function to use as the value of standard library's sorted function key argument such that the objects are sorted by: Privacy, Kind and Name.

Example:

    children = sorted((o for o in ob.contents.values() if o.isVisible),
                  key=objects_order)

Parameters
o:`model.Documentable`	Undocumented
Returns
`Tuple[int, int, str]`	Undocumented

def format_decorators(obj):

Undocumented

Parameters
obj:`Union[model.Function, model.Attribute]`	Undocumented
Returns
`Iterator[Flattenable]`	Undocumented

def format_signature(function):

Return a stan representation of a nicely-formatted source-like function signature for the given Function. Arguments default values are linked to the appropriate objects when possible.

Parameters
function:`model.Function`	Undocumented
Returns
`Flattenable`	Undocumented

def overriding_subclasses(c, name, firstcall=True):

Undocumented

Parameters
c:`model.Class`	Undocumented
name:`str`	Undocumented
firstcall:`bool`	Undocumented
Returns
`Iterator[model.Class]`	Undocumented

def nested_bases(b):

Undocumented

Parameters
b:`model.Class`	Undocumented
Returns
`Sequence[Tuple[model.Class, ...]]`	Undocumented

def unmasked_attrs(baselist):

Undocumented

Parameters
baselist:`Sequence[model.Documentable]`	Undocumented
Returns
`Sequence[model.Documentable]`	Undocumented

def assembleList(system, label, lst, idbase, page_url):

Undocumented

Parameters
system:`model.System`	Undocumented
label:`str`	Undocumented
lst:`Sequence[str]`	Undocumented
idbase:`str`	Undocumented
page_url:`str`	Undocumented
Returns
`Optional[Flattenable]`	Undocumented

commonpages: Mapping[str, Type[CommonPage]] =

List all page classes: ties documentable class name with the page class used for rendering

Value

{'Module': ModulePage,
 'Package': PackagePage,
 'Class': ClassPage,
 'ZopeInterfaceClass': ZopeInterfaceClassPage}