API documentation information about a singe Python namespace value.
(I.e., a module or a class).
|
|
|
| Call Graph |
|
bool
|
|
| Call Graph |
|
|
|
apidoc_links(self,
**filters)
Return a list of all APIDocs that are directly linked
from this APIDoc (i.e., are contained or pointed to by
one or more of this APIDoc's attributes.) |
source code
call graph
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
group_names(self)
Return a list of the group names defined by this namespace, in the
order in which they should be listed, with no duplicates. |
source code
call graph
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
Inherited from ValueDoc:
__getstate__,
__repr__,
__setstate__
Inherited from APIDoc:
__cmp__,
__hash__,
__setattr__,
__str__,
merge_and_overwrite,
pp,
specialize_to
Inherited from object:
__delattr__,
__getattribute__,
__new__,
__reduce__,
__reduce_ex__
|
|
Inherited from ValueDoc:
pyval_repr,
summary_pyval_repr
|
|
Inherited from ValueDoc:
canonical_name,
toktree
|
dict from string to VariableDoc
|
variables = _Sentinel('UNKNOWN')
The contents of the namespace, encoded as a dictionary mapping from
identifiers to VariableDocs.
|
list of VariableDoc
|
sorted_variables = _Sentinel('UNKNOWN')
A list of all variables defined by this namespace, in sorted order.
|
list of str
|
sort_spec = _Sentinel('UNKNOWN')
The order in which variables should be listed, encoded as a list of
names.
|
list of (str,list)
|
group_specs = _Sentinel('UNKNOWN')
The groups that are defined by this namespace's docstrings.
|
dict from str to list of VariableDoc
|
variable_groups = _Sentinel('UNKNOWN')
A dictionary specifying what group each variable belongs to.
|
|
Inherited from ValueDoc:
parse_repr,
pyval
|
|
Inherited from ValueDoc:
defining_module
|
|
Inherited from ValueDoc:
proxy_for
|
|
Inherited from APIDoc:
docstring,
docstring_lineno
|
|
Inherited from APIDoc:
descr,
extra_docstring_fields,
metadata,
other_docs,
summary
|
|
Inherited from APIDoc:
docs_extracted_by
|