Classes for encoding API documentation about Python programs. These
classes are used as a common representation for combining information
derived from introspection and from parsing.
|
DottedName
A sequence of identifiers, separated by periods, used to name a
Python variable, value, or argument.
|
|
_Sentinel
A unique value that won't compare equal to any other value.
|
|
APIDoc
API documentation information for a single element of a Python
program.
|
|
VariableDoc
API documentation information about a single Python
variable.
|
|
ValueDoc
API documentation information about a single Python value.
|
|
GenericValueDoc
API documentation about a 'generic' value, i.e., one that does
not have its own docstring or any information other than its value
and parse representation.
|
|
NamespaceDoc
API documentation information about a singe Python namespace
value.
|
|
ModuleDoc
API documentation information about a single module.
|
|
ClassDoc
API documentation information about a single class.
|
|
RoutineDoc
API documentation information about a single routine.
|
|
ClassMethodDoc
|
|
StaticMethodDoc
|
|
PropertyDoc
API documentation information about a single property.
|
|
DocIndex
[xx] out of date.
|
|
|
Call Graph |
|
|
|
Call Graph |
|
|
pp_apidoc(api_doc,
doublespace=0,
depth=5,
exclude=( ) ,
include=( ) ,
backpointers=True)
Returns:
A multiline pretty-printed string representation for the given
APIDoc . |
source code
|
|
|
_pp_list(api_doc,
items,
doublespace,
depth,
exclude,
include,
backpointers,
is_last) |
source code
|
|
|
_pp_dict(api_doc,
dict,
doublespace,
depth,
exclude,
include,
backpointers,
is_last) |
source code
|
|
|
_pp_apidoc(api_doc,
val,
doublespace,
depth,
exclude,
include,
backpointers,
is_last) |
source code
|
|
|
_pp_val(api_doc,
val,
doublespace,
depth,
exclude,
include,
backpointers) |
source code
|
|