|
clear_cache()
Discard any cached APIDoc values that have been computed
for introspected values. |
source code
|
|
|
introspect_docs(value=None,
name=None,
filename=None,
context=None,
is_script=False,
module_name=None)
Generate the API documentation for a specified object by
introspecting Python values, and return it as a ValueDoc. |
source code
call graph
|
|
Call Graph |
|
|
_get_valuedoc(value)
If a ValueDoc for the given value exists in the valuedoc
cache, then return it; otherwise, create a new ValueDoc ,
add it to the cache, and return it. |
source code
call graph
|
|
Call Graph |
|
|
introspect_module(module,
module_doc,
module_name=None,
preliminary=False)
Add API documentation information about the module
module to module_doc . |
source code
call graph
|
|
Call Graph |
|
|
introspect_class(cls,
class_doc,
module_name=None)
Add API documentation information about the class cls to
class_doc . |
source code
call graph
|
|
Call Graph |
|
|
introspect_routine(routine,
routine_doc,
module_name=None)
Add API documentation information about the function
routine to routine_doc (specializing it to
Routine_doc ). |
source code
call graph
|
|
Call Graph |
|
|
introspect_property(prop,
prop_doc,
module_name=None)
Add API documentation information about the property
prop to prop_doc (specializing it to
PropertyDoc ). |
source code
call graph
|
|
Call Graph |
|
|
introspect_other(val,
val_doc,
module_name=None)
Specialize val_doc to a GenericValueDoc and return it. |
source code
call graph
|
|
Call Graph |
|
|
|
Call Graph |
|
|
|
|
is_future_feature(object)
Return True if object results from a from
__future__ import feature statement. |
source code
call graph
|
|
Call Graph |
|
unicode
|
get_docstring(value,
module_name=None)
Return the docstring for the given value; or None if it
does not have a docstring. |
source code
call graph
|
|
Call Graph |
|
DottedName or UNKNOWN
|
|
Call Graph |
|
|
|
Call Graph |
|
|
|
DottedName
|
get_containing_module(value)
Return the name of the module containing the given value, or
None if the module name can't be determined. |
source code
call graph
|
|
Call Graph |
|
module
|
|
Call Graph |
|
|
|
|
|
Call Graph |
|
|
|
|
|
|
|
Call Graph |
|
|
|
Call Graph |
|
|
|
Call Graph |
|
|
|
Call Graph |
|
|
|
|
|
|
|
|
|
Call Graph |
|
|
|
|
|
|
|