epydoc.markup.plaintext

Package epydoc :: Package markup :: Module plaintext

Module plaintext
source code

Parser for plaintext docstrings. Plaintext docstrings are rendered as verbatim output, preserving all whitespace.

Classes	[hide private]

ParsedPlaintextDocstring

Functions	[hide private]

ParsedPlaintextDocstring, list of ParseError parse_docstring(docstring, errors, **options)

Function Details	[hide private]

Returns: ParsedPlaintextDocstring, list of ParseError: A pair (d, e), where d is a ParsedDocstring that encodes the contents of the given plaintext docstring; and e is a list of errors that were generated while parsing the docstring.