Element
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
_add_para(doc,
para_token,
stack,
indent_stack,
errors)
Colorize the given paragraph, and add it to the DOM tree. |
source code
call graph
|
|
| Call Graph |
|
|
|
_add_section(doc,
heading_token,
stack,
indent_stack,
errors)
Add a new section to the DOM tree, with the given heading. |
source code
call graph
|
|
| Call Graph |
|
|
|
_add_list(doc,
bullet_token,
stack,
indent_stack,
errors)
Add a new list item or field to the DOM tree, with the given
bullet or field tag. |
source code
call graph
|
|
| Call Graph |
|
int
|
|
| Call Graph |
|
int
|
|
| Call Graph |
|
int
|
_tokenize_listart(lines,
start,
bullet_indent,
tokens,
errors)
Construct Tokens for the bullet and the first paragraph of the
list item (or field) starting at lines[start], and
append them to tokens. |
source code
call graph
|
|
| Call Graph |
|
int
|
|
| Call Graph |
|
list of Token
|
_tokenize(str,
errors)
Split a given formatted docstring into an ordered list of
Tokens, according to the epytext markup rules. |
source code
call graph
|
|
| Call Graph |
|
Element
|
_colorize(doc,
token,
errors,
tagName='para')
Given a string containing the contents of a paragraph, produce a
DOM Element encoding that paragraph. |
source code
call graph
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
|
|
|
| Call Graph |
|
string
|
to_epytext(tree,
indent=0,
seclevel=0)
Convert a DOM document encoding epytext back to an epytext
string. |
source code
|
|
string
|
|
| Call Graph |
|
string
|
to_debug(tree,
indent=4,
seclevel=0)
Convert a DOM document encoding epytext back to an epytext string,
annotated with extra debugging information. |
source code
|
|
Element
|
pparse(str,
show_warnings=1,
show_errors=1,
stream=sys.stderr)
Pretty-parse the string. |
source code
|
|
Element
|
|
Element
|
|
| Call Graph |
|
|
ParsedDocstring
|
parse_docstring(docstring,
errors,
**options)
Parse the given docstring, which is formatted using epytext; and
return a ParsedDocstring representation of its
contents. |
source code
call graph
|
|
| Call Graph |
|
|
|
_HEADING_CHARS = '=-~'
|
|
|
_ESCAPES = {'lb': '{', 'rb': '}'}
|
|
|
SYMBOLS = ['<-', '->', '^', 'v', 'alpha', 'beta', 'gamma', 'de...
A list of the of escape symbols that are supported by epydoc.
|
|
|
_SYMBOLS = {'->': 1, '<-': 1, '<=': 1, '>=': 1, 'Alpha': 1, 'B...
|
|
|
__doc__ = __doc__.replace('<<<SYMBOLS>>>', symblist)
|
|
|
_COLORIZING_TAGS = {'B': 'bold', 'C': 'code', 'E': 'escape', '...
|
|
|
_LINK_COLORIZING_TAGS = ['link', 'uri']
|
|
|
_BULLET_RE = re.compile(r'-( +|$)|(\d+\.)+( +|$)|@\w+( [^\{\}:...
|
|
|
_LIST_BULLET_RE = re.compile(r'-( +|$)|(\d+\.)+( +|$)')
|
|
|
_FIELD_BULLET_RE = re.compile(r'@\w+( [^\{\}:\n]+)?:')
|
|
|
_BRACE_RE = re.compile(r'[\{\}]')
|
|
|
_TARGET_RE = re.compile(r'^(.*?)\s*<(?:URI:|L:)?([^<>]+)>$')
|
|
|
GRAPH_TYPES = ['classtree', 'packagetree', 'importgraph', 'cal...
|
|
|
SYMBOL_TO_PLAINTEXT = {'crarr': '\\'}
|