Home | Trees | Indices | Help |
|
---|
|
ParsedDocstring
s
support the following operations:
The parse()
function provides a single interface to the epydoc.markup
package: it takes a docstring and the name of a markup language;
delegates to the appropriate parser; and returns the parsed docstring
(along with any errors or warnings that were generated).
ParsedDocstring
output generation methods
(to_format()
) use a DocstringLinker to link the docstring output with the
rest of the documentation that epydoc generates.
DocstringLinker
s are currently responsible for translating
two kinds of crossreference:
A parsed docstring's fields can be extracted using the ParsedDocstring.split_fields() method. This method
divides a docstring into its main body and a list of Fields, each of
which encodes a single field. The field's bodies are encoded as
ParsedDocstring
s.
|
|||
|
|
|||
ParsedDocstring A standard intermediate representation for parsed docstrings that can be used to generate output. |
|||
Field The contents of a docstring's field. |
|||
DocstringLinker A translator for crossreference links into and out of a ParsedDocstring .
|
|||
ConcatenatedDocstring | |||
Errors and Warnings | |||
---|---|---|---|
ParseError The base class for errors generated while parsing docstrings. |
|
|||
ParsedDocstring |
|
||
|
|||
|
|||
Utility Functions | |||
---|---|---|---|
ParsedDocstring |
|
|
|||
_markup_language_registry = {'restructuredtext': 'epydoc.marku
|
|||
MARKUP_LANGUAGES_USED =
|
|||
_parse_warnings =
Used by _parse_warn. |
|||
int
|
SCRWIDTH The default width with which text will be wrapped when formatting the output of the parser. |
|
ParsedDocstring . If any fatal ParseError s are
encountered while parsing the docstring, then the docstring will be
rendered as plaintext, instead.
|
name , which can be
parsed by the function parse_function .
|
|
|
|
_markup_language_registry
|
MARKUP_LANGUAGES_USED
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0beta1 on Thu Mar 1 04:23:17 2007 | http://epydoc.sourceforge.net |