|
|
|
| Call Graph |
|
|
|
|
|
|
|
| Call Graph |
|
list of markup.Field
|
|
| Call Graph |
|
|
|
report_errors(api_doc,
docindex,
parse_errors,
field_warnings)
A helper function for parse_docstring() that reports any markup warnings
and field warnings that we encountered while processing
api_doc's docstring. |
source code
call graph
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
|
|
process_summary_field(api_doc,
docindex,
tag,
arg,
descr)
Store descr in api_doc.summary |
source code
|
|
|
|
process_include_field(api_doc,
docindex,
tag,
arg,
descr)
Copy the docstring contents from the object named in
descr |
source code
|
|
|
|
process_undocumented_field(api_doc,
docindex,
tag,
arg,
descr)
Remove any documentation for the variables named in
descr |
source code
|
|
|
|
process_group_field(api_doc,
docindex,
tag,
arg,
descr)
Define a group named arg containing the variables whose
names are listed in descr. |
source code
call graph
|
|
| Call Graph |
|
|
|
process_deffield_field(api_doc,
docindex,
tag,
arg,
descr)
Define a new custom field. |
source code
call graph
|
|
| Call Graph |
|
|
|
process_raise_field(api_doc,
docindex,
tag,
arg,
descr)
Record the fact that api_doc can raise the exception
named tag in api_doc.exception_descrs. |
source code
call graph
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
check_type_fields(api_doc,
field_warnings)
Check to make sure that all type fields correspond to some documented
parameter; if not, append a warning to field_warnings. |
source code
call graph
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
get_docformat(api_doc,
docindex)
Return the name of the markup language that should be used to parse
the API documentation for the given object. |
source code
call graph
|
|
|
|
|
| Call Graph |
|
list of string
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
None
|
|
| Call Graph |
|
|
|
STANDARD_FIELDS = [<Field: deprecated>, <Field: version>, <Fie...
A list of the standard simple fields accepted by epydoc.
|
|
|
DEFAULT_DOCFORMAT = 'plaintext'
The name of the default markup languge used to process docstrings.
|
|
|
RETURN_PDS = markup.parse('Returns:', markup= 'epytext')
A ParsedDocstring containing the text 'Returns'.
|
|
|
UNEXPECTED_ARG = '%r did not expect an argument'
|
|
|
EXPECTED_ARG = '%r expected an argument'
|
|
|
EXPECTED_SINGLE_ARG = '%r expected a single argument'
|
|
|
BAD_CONTEXT = 'Invalid context for %r'
|
|
|
REDEFINED = 'Redefinition of %s'
|
|
|
UNKNOWN_TAG = 'Unknown field tag %r'
|
|
|
BAD_PARAM = '@%s for unknown parameter %s'
|
|
|
_field_dispatch_table = {}
|
|
|
PARAMETER_TAGS = ('arg', 'argument', 'parameter', 'param', 'kw...
|
|
|
VARIABLE_TAGS = ('cvar', 'cvariable', 'ivar', 'ivariable')
|
|
|
EXCEPTION_TAGS = ('raise', 'raises', 'except', 'exception')
|
|
|
_IDENTIFIER_LIST_REGEXP = re.compile(r'^[\w\.\*]+([\s,:;]\s*[\...
|
|
|
_SIGNATURE_RE = re.compile(r'^\s*((?P<self>\w+)\.)?(?P<func>\w...
A regular expression that is used to extract signatures from
docstrings.
|