pydoctor.templatewriter.pages

package documentation
(source)

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

Module attributechild Undocumented
Module functionchild Undocumented
Module sidebar Classes for the sidebar generation.
Module table Undocumented

From __init__.py:

Class ClassPage Undocumented
Class CommonPage No class docstring; 0/2 property, 0/2 instance variable, 0/1 class variable, 1/20 method documented
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 Convert list of object names into a stan tree with clickable links.
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 get_override_info 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.
Constant commonpages List all page classes: ties documentable class name with the page class used for rendering
def objects_order(o): (source)

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.DocumentableUndocumented
Returns
Tuple[int, int, str]Undocumented
def format_decorators(obj): (source)

Undocumented

Parameters
obj:Union[model.Function, model.Attribute]Undocumented
Returns
Iterator[Flattenable]Undocumented
def format_signature(function): (source)

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.FunctionUndocumented
Returns
FlattenableUndocumented
def assembleList(system, label, lst, page_url): (source)

Convert list of object names into a stan tree with clickable links.

Parameters
system:model.SystemUndocumented
label:strUndocumented
lst:Sequence[str]Undocumented
page_url:strUndocumented
Returns
Optional[Flattenable]Undocumented
def get_override_info(cls, member_name, page_url=None): (source)

Undocumented

Parameters
cls:model.ClassUndocumented
member_name:strUndocumented
page_url:Optional[str]Undocumented
Returns
Iterator[Tag]Undocumented
commonpages: Mapping[str, Type[CommonPage]] = (source)

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

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