<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.markup.epytext</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
Module epytext
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.markup.epytext-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module epytext</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html">source code</a></span></p>
<p>Parser for epytext strings. Epytext is a lightweight markup whose
primary intended application is Python documentation strings. This
parser converts Epytext strings to a simple DOM-like representation
(encoded as a tree of <a href="epydoc.markup.epytext.Element-class.html"
class="link">Element</a> objects and strings). Epytext strings can
contain the following <a name="index-structural_blocks"></a><i
class="indexterm">structural blocks</i>:</p>
<ul>
<li>
<a name="index-epytext"></a><i class="indexterm">epytext</i>: The
top-level element of the DOM tree.
</li>
<li>
<a name="index-para"></a><i class="indexterm">para</i>: A paragraph
of text. Paragraphs contain no newlines, and all spaces are soft.
</li>
<li>
<a name="index-section"></a><i class="indexterm">section</i>: A
section or subsection.
</li>
<li>
<a name="index-field"></a><i class="indexterm">field</i>: A tagged
field. These fields provide information about specific aspects of a
Python object, such as the description of a function's parameter, or
the author of a module.
</li>
<li>
<a name="index-literalblock"></a><i
class="indexterm">literalblock</i>: A block of literal text. This
text should be displayed as it would be displayed in plaintext. The
parser removes the appropriate amount of leading whitespace from each
line in the literal block.
</li>
<li>
<a name="index-doctestblock"></a><i
class="indexterm">doctestblock</i>: A block containing sample python
code, formatted according to the specifications of the
<code>doctest</code> module.
</li>
<li>
<a name="index-ulist"></a><i class="indexterm">ulist</i>: An
unordered list.
</li>
<li>
<a name="index-olist"></a><i class="indexterm">olist</i>: An ordered
list.
</li>
<li>
<a name="index-li"></a><i class="indexterm">li</i>: A list item.
This tag is used both for unordered list items and for ordered list
items.
</li>
</ul>
<p>Additionally, the following <a name="index-inline_regions"></a><i
class="indexterm">inline regions</i> may be used within <code>para</code>
blocks:</p>
<ul>
<li>
<a name="index-code"></a><i class="indexterm">code</i>: Source code
and identifiers.
</li>
<li>
<a name="index-math"></a><i class="indexterm">math</i>:
Mathematical expressions.
</li>
<li>
<a name="index-index"></a><i class="indexterm">index</i>: A term
which should be included in an index, if one is generated.
</li>
<li>
<a name="index-italic"></a><i class="indexterm">italic</i>:
Italicized text.
</li>
<li>
<a name="index-bold"></a><i class="indexterm">bold</i>: Bold-faced
text.
</li>
<li>
<a name="index-uri"></a><i class="indexterm">uri</i>: A Universal
Resource Indicator (URI) or Universal Resource Locator (URL)
</li>
<li>
<a name="index-link"></a><i class="indexterm">link</i>: A Python
identifier which should be hyperlinked to the named object's
documentation, when possible.
</li>
</ul>
<p>The returned DOM tree will conform to the the following Document Type
Description:</p>
<pre class="literalblock">
<!ENTITY % colorized '(code | math | index | italic |
bold | uri | link | symbol)*'>
<!ELEMENT epytext ((para | literalblock | doctestblock |
section | ulist | olist)*, fieldlist?)>
<!ELEMENT para (#PCDATA | %colorized;)*>
<!ELEMENT section (para | listblock | doctestblock |
section | ulist | olist)+>
<!ELEMENT fieldlist (field+)>
<!ELEMENT field (tag, arg?, (para | listblock | doctestblock)
ulist | olist)+)>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT arg (#PCDATA)>
<!ELEMENT literalblock (#PCDATA | %colorized;)*>
<!ELEMENT doctestblock (#PCDATA)>
<!ELEMENT ulist (li+)>
<!ELEMENT olist (li+)>
<!ELEMENT li (para | literalblock | doctestblock | ulist | olist)+>
<!ATTLIST li bullet NMTOKEN #IMPLIED>
<!ATTLIST olist start NMTOKEN #IMPLIED>
<!ELEMENT uri (name, target)>
<!ELEMENT link (name, target)>
<!ELEMENT name (#PCDATA | %colorized;)*>
<!ELEMENT target (#PCDATA)>
<!ELEMENT code (#PCDATA | %colorized;)*>
<!ELEMENT math (#PCDATA | %colorized;)*>
<!ELEMENT italic (#PCDATA | %colorized;)*>
<!ELEMENT bold (#PCDATA | %colorized;)*>
<!ELEMENT indexed (#PCDATA | %colorized;)>
<!ATTLIST code style CDATA #IMPLIED>
<!ELEMENT symbol (#PCDATA)>
</pre>
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext.Element-class.html" class="summary-name">Element</a><br />
A very simple DOM-like representation for parsed epytext documents.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext.Token-class.html" class="summary-name">Token</a><br />
<code>Token</code>s are an intermediate data structure used while
constructing the structuring DOM tree for a formatted docstring.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext.TokenizationError-class.html" class="summary-name">TokenizationError</a><br />
An error generated while tokenizing a formatted documentation
string.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext.StructuringError-class.html" class="summary-name">StructuringError</a><br />
An error generated while structuring a formatted documentation
string.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext.ColorizingError-class.html" class="summary-name">ColorizingError</a><br />
An error generated while colorizing a paragraph.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html" class="summary-name">ParsedEpytextDocstring</a>
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>Element</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse" class="summary-sig-name">parse</a>(<span class="summary-sig-arg">str</span>,
<span class="summary-sig-arg">errors</span>=<span class="summary-sig-default">None</span>)</span><br />
Return a DOM tree encoding the contents of an epytext string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#parse">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_2-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_2-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_2" name="call_graph_for_parse_2">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="359,6,522,38" />
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#to_dom" title="Token.to_dom()" alt="" coords="368,62,512,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_list" title="_add_list()" alt="" coords="388,118,492,150" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_para" title="_add_para()" alt="" coords="384,174,496,206" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_section" title="_add_section()" alt="" coords="374,230,507,262" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_pop_completed_blocks" title="_pop_completed_blocks()" alt="" coords="332,286,548,318" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_raise_graphs" title="_raise_graphs()" alt="" coords="371,342,510,374" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="387,398,494,430" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="208,202,283,234" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse_docstring" title="parse_docstring()" alt="" coords="7,202,159,234" />
</map>
<img src="call_graph_for_parse_2.gif" alt='' usemap="#call_graph_for_parse_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_raise_graphs"></a><span class="summary-sig-name">_raise_graphs</span>(<span class="summary-sig-arg">tree</span>,
<span class="summary-sig-arg">parent</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_raise_graphs">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__raise_graphs-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__raise_graphs-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__raise_graphs" name="call_graph_for__raise_graphs">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="315,30,478,62" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_raise_graphs" title="_raise_graphs()" alt="" coords="128,30,267,62" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="6,30,80,62" />
</map>
<img src="call_graph_for__raise_graphs.gif" alt='' usemap="#call_graph_for__raise_graphs" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_pop_completed_blocks" class="summary-sig-name" onclick="show_private();">_pop_completed_blocks</a>(<span class="summary-sig-arg">token</span>,
<span class="summary-sig-arg">stack</span>,
<span class="summary-sig-arg">indent_stack</span>)</span><br />
Pop any completed blocks off the stack.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_pop_completed_blocks">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__pop_completed_-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__pop_completed_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__pop_completed_" name="call_graph_for__pop_completed_">
<area shape="rect" href="epydoc.markup.epytext-module.html#_pop_completed_blocks" title="_pop_completed_blocks()" alt="" coords="129,6,345,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="5,6,80,38" />
</map>
<img src="call_graph_for__pop_completed_.gif" alt='' usemap="#call_graph_for__pop_completed_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_add_para"></a><span class="summary-sig-name">_add_para</span>(<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">para_token</span>,
<span class="summary-sig-arg">stack</span>,
<span class="summary-sig-arg">indent_stack</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Colorize the given paragraph, and add it to the DOM tree.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_add_para">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__add_para-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__add_para-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__add_para" name="call_graph_for__add_para">
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_para" title="_add_para()" alt="" coords="130,6,242,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize" title="_colorize()" alt="" coords="292,6,396,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="6,6,80,38" />
</map>
<img src="call_graph_for__add_para.gif" alt='' usemap="#call_graph_for__add_para" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_add_section"></a><span class="summary-sig-name">_add_section</span>(<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">heading_token</span>,
<span class="summary-sig-arg">stack</span>,
<span class="summary-sig-arg">indent_stack</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Add a new section to the DOM tree, with the given heading.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_add_section">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__add_section-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__add_section-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__add_section" name="call_graph_for__add_section">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="309,6,472,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_section" title="_add_section()" alt="" coords="128,34,261,66" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize" title="_colorize()" alt="" coords="339,62,443,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="5,34,80,66" />
</map>
<img src="call_graph_for__add_section.gif" alt='' usemap="#call_graph_for__add_section" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_add_list" class="summary-sig-name" onclick="show_private();">_add_list</a>(<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">bullet_token</span>,
<span class="summary-sig-arg">stack</span>,
<span class="summary-sig-arg">indent_stack</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Add a new list item or field to the DOM tree, with the given bullet
or field tag.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_add_list">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__add_list-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__add_list-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__add_list" name="call_graph_for__add_list">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="280,6,443,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_list" title="_add_list()" alt="" coords="128,6,232,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="5,6,80,38" />
</map>
<img src="call_graph_for__add_list.gif" alt='' usemap="#call_graph_for__add_list" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_tokenize_doctest" class="summary-sig-name" onclick="show_private();">_tokenize_doctest</a>(<span class="summary-sig-arg">lines</span>,
<span class="summary-sig-arg">start</span>,
<span class="summary-sig-arg">block_indent</span>,
<span class="summary-sig-arg">tokens</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a> containing the doctest block starting at
<code>lines[start]</code>, and append it to <code>tokens</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize_doctest">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize_docte-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__tokenize_docte-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize_docte" name="call_graph_for__tokenize_docte">
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#__init__" title="Token.__init__()" alt="" coords="383,6,529,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="7,6,113,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_doctest" title="_tokenize_doctest()" alt="" coords="163,6,333,38" />
</map>
<img src="call_graph_for__tokenize_docte.gif" alt='' usemap="#call_graph_for__tokenize_docte" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_tokenize_literal" class="summary-sig-name" onclick="show_private();">_tokenize_literal</a>(<span class="summary-sig-arg">lines</span>,
<span class="summary-sig-arg">start</span>,
<span class="summary-sig-arg">block_indent</span>,
<span class="summary-sig-arg">tokens</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a> containing the literal block starting at
<code>lines[start]</code>, and append it to <code>tokens</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize_literal">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize_liter-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__tokenize_liter-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize_liter" name="call_graph_for__tokenize_liter">
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#__init__" title="Token.__init__()" alt="" coords="372,6,519,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="7,6,113,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_literal" title="_tokenize_literal()" alt="" coords="163,6,323,38" />
</map>
<img src="call_graph_for__tokenize_liter.gif" alt='' usemap="#call_graph_for__tokenize_liter" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_tokenize_listart" class="summary-sig-name" onclick="show_private();">_tokenize_listart</a>(<span class="summary-sig-arg">lines</span>,
<span class="summary-sig-arg">start</span>,
<span class="summary-sig-arg">bullet_indent</span>,
<span class="summary-sig-arg">tokens</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Construct <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a>s for the bullet and the first paragraph of the
list item (or field) starting at <code>lines[start]</code>, and
append them to <code>tokens</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize_listart">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize_lista-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__tokenize_lista-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize_lista" name="call_graph_for__tokenize_lista">
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#__init__" title="Token.__init__()" alt="" coords="372,6,519,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="7,6,113,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_listart" title="_tokenize_listart()" alt="" coords="163,6,323,38" />
</map>
<img src="call_graph_for__tokenize_lista.gif" alt='' usemap="#call_graph_for__tokenize_lista" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_tokenize_para" class="summary-sig-name" onclick="show_private();">_tokenize_para</a>(<span class="summary-sig-arg">lines</span>,
<span class="summary-sig-arg">start</span>,
<span class="summary-sig-arg">para_indent</span>,
<span class="summary-sig-arg">tokens</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a> containing the paragraph starting at
<code>lines[start]</code>, and append it to <code>tokens</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize_para">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize_para-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__tokenize_para-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize_para" name="call_graph_for__tokenize_para">
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#__init__" title="Token.__init__()" alt="" coords="362,6,508,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="7,6,114,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_para" title="_tokenize_para()" alt="" coords="163,6,312,38" />
</map>
<img src="call_graph_for__tokenize_para.gif" alt='' usemap="#call_graph_for__tokenize_para" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>list</code> of <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_tokenize" class="summary-sig-name" onclick="show_private();">_tokenize</a>(<span class="summary-sig-arg">str</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Split a given formatted docstring into an ordered list of
<code>Token</code>s, according to the epytext markup rules.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__tokenize-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize" name="call_graph_for__tokenize">
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="129,90,236,122" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_doctest" title="_tokenize_doctest()" alt="" coords="285,6,456,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_listart" title="_tokenize_listart()" alt="" coords="291,62,451,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_literal" title="_tokenize_literal()" alt="" coords="291,118,451,150" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_para" title="_tokenize_para()" alt="" coords="296,174,445,206" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="5,90,80,122" />
</map>
<img src="call_graph_for__tokenize.gif" alt='' usemap="#call_graph_for__tokenize" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>Element</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_colorize" class="summary-sig-name" onclick="show_private();">_colorize</a>(<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">token</span>,
<span class="summary-sig-arg">errors</span>,
<span class="summary-sig-arg">tagName</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">para</code><code class="variable-quote">'</code></span>)</span><br />
Given a string containing the contents of a paragraph, produce a DOM
<code>Element</code> encoding that paragraph.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_colorize">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__colorize-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__colorize-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__colorize" name="call_graph_for__colorize">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="341,6,504,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_para" title="_add_para()" alt="" coords="16,34,128,66" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize" title="_colorize()" alt="" coords="188,62,292,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_section" title="_add_section()" alt="" coords="5,90,139,122" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize_graph" title="_colorize_graph()" alt="" coords="345,62,500,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize_link" title="_colorize_link()" alt="" coords="352,118,493,150" />
</map>
<img src="call_graph_for__colorize.gif" alt='' usemap="#call_graph_for__colorize" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#_colorize_graph" class="summary-sig-name" onclick="show_private();">_colorize_graph</a>(<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">graph</span>,
<span class="summary-sig-arg">token</span>,
<span class="summary-sig-arg">end</span>,
<span class="summary-sig-arg">errors</span>)</span><br />
Eg:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_colorize_graph">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__colorize_graph-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__colorize_graph-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__colorize_graph" name="call_graph_for__colorize_graph">
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize" title="_colorize()" alt="" coords="7,6,111,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize_graph" title="_colorize_graph()" alt="" coords="162,6,316,38" />
</map>
<img src="call_graph_for__colorize_graph.gif" alt='' usemap="#call_graph_for__colorize_graph" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_colorize_link"></a><span class="summary-sig-name">_colorize_link</span>(<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">link</span>,
<span class="summary-sig-arg">token</span>,
<span class="summary-sig-arg">end</span>,
<span class="summary-sig-arg">errors</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_colorize_link">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__colorize_link-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__colorize_link-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__colorize_link" name="call_graph_for__colorize_link">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="352,6,515,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize" title="_colorize()" alt="" coords="7,6,111,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize_link" title="_colorize_link()" alt="" coords="161,6,303,38" />
</map>
<img src="call_graph_for__colorize_link.gif" alt='' usemap="#call_graph_for__colorize_link" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>string</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_epytext" class="summary-sig-name">to_epytext</a>(<span class="summary-sig-arg">tree</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">seclevel</span>=<span class="summary-sig-default">0</span>)</span><br />
Convert a DOM document encoding epytext back to an epytext string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#to_epytext">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>string</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_plaintext" class="summary-sig-name">to_plaintext</a>(<span class="summary-sig-arg">tree</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">seclevel</span>=<span class="summary-sig-default">0</span>)</span><br />
Convert a DOM document encoding epytext to a string representation.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#to_plaintext">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_plaintext-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_to_plaintext-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_to_plaintext" name="call_graph_for_to_plaintext">
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext" title="ParsedEpytextDocstring.to_plaintext()" alt="" coords="7,30,313,62" />
<area shape="rect" href="epydoc.markup.epytext-module.html#to_plaintext" title="to_plaintext()" alt="" coords="363,30,485,62" />
<area shape="rect" href="epydoc.util-module.html#wordwrap" title="util.wordwrap()" alt="" coords="535,30,673,62" />
</map>
<img src="call_graph_for_to_plaintext.gif" alt='' usemap="#call_graph_for_to_plaintext" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>string</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_debug" class="summary-sig-name">to_debug</a>(<span class="summary-sig-arg">tree</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">4</span>,
<span class="summary-sig-arg">seclevel</span>=<span class="summary-sig-default">0</span>)</span><br />
Convert a DOM document encoding epytext back to an epytext string,
annotated with extra debugging information.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#to_debug">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>Element</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#pparse" class="summary-sig-name">pparse</a>(<span class="summary-sig-arg">str</span>,
<span class="summary-sig-arg">show_warnings</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">show_errors</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">stream</span>=<span class="summary-sig-default">sys.stderr</span>)</span><br />
Pretty-parse the string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#pparse">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>Element</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_as_literal" class="summary-sig-name">parse_as_literal</a>(<span class="summary-sig-arg">str</span>)</span><br />
Return a DOM document matching the epytext DTD, containing a single
literal block.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#parse_as_literal">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>Element</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_as_para" class="summary-sig-name">parse_as_para</a>(<span class="summary-sig-arg">str</span>)</span><br />
Return a DOM document matching the epytext DTD, containing a single
paragraph.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#parse_as_para">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_as_para-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_as_para-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_as_para" name="call_graph_for_parse_as_para">
<area shape="rect" href="epydoc.docstringparser-module.html#add_metadata_from_var" title="docstringparser.add_metadata_from_var()" alt="" coords="7,6,340,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse_as_para" title="parse_as_para()" alt="" coords="390,6,531,38" />
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="579,6,742,38" />
</map>
<img src="call_graph_for_parse_as_para.gif" alt='' usemap="#call_graph_for_parse_as_para" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="epydoc.markup.ParsedDocstring-class.html"
class="link">ParsedDocstring</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_docstring" class="summary-sig-name">parse_docstring</a>(<span class="summary-sig-arg">docstring</span>,
<span class="summary-sig-arg">errors</span>,
<span class="summary-sig-arg">**options</span>)</span><br />
Parse the given docstring, which is formatted using epytext; and
return a <code>ParsedDocstring</code> representation of its contents.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#parse_docstring">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_docstring_2-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_docstring_2-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_docstring_2" name="call_graph_for_parse_docstring_2">
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__init__" title="ParsedEpytextDocstring.__init__()" alt="" coords="332,6,612,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="435,62,510,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse_docstring" title="parse_docstring()" alt="" coords="130,34,282,66" />
<area shape="rect" href="epydoc.markup-module.html#parse" title="parse()" alt="" coords="6,34,80,66" />
</map>
<img src="call_graph_for_parse_docstring_2.gif" alt='' usemap="#call_graph_for_parse_docstring_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_HEADING_CHARS"></a><span class="summary-name">_HEADING_CHARS</span> = <code title="'=-~'"><code class="variable-quote">'</code><code class="variable-string">=-~</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_ESCAPES"></a><span class="summary-name">_ESCAPES</span> = <code title="{'lb': '{', 'rb': '}'}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">lb</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">{</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">rb</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">}</code><code class="variable-quote">'</code><code class="variable-group">}</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext-module.html#SYMBOLS" class="summary-name">SYMBOLS</a> = <code title="['<-',
'->',
'^',
'v',
'alpha',
'beta',
'gamma',
'delta',
..."><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string"><-</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">-></code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">^</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">v</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">alpha</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">beta</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">gamma</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">de</code><code class="variable-ellipsis">...</code></code><br />
A list of the of escape symbols that are supported by epydoc.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext-module.html#_SYMBOLS" class="summary-name" onclick="show_private();">_SYMBOLS</a> = <code title="{'->': 1,
'<-': 1,
'<=': 1,
'>=': 1,
'Alpha': 1,
'Beta': 1,
'Chi': 1,
'Delta': 1,
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">-></code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string"><-</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string"><=</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">>=</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Alpha</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">B</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__doc__"></a><span class="summary-name">__doc__</span> = <code title="__doc__.replace('<<<SYMBOLS>>>', symblist)">__doc__.replace('<<<SYMBOLS>>>', symblist)</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext-module.html#_COLORIZING_TAGS" class="summary-name" onclick="show_private();">_COLORIZING_TAGS</a> = <code title="{'B': 'bold',
'C': 'code',
'E': 'escape',
'G': 'graph',
'I': 'italic',
'L': 'link',
'M': 'math',
'S': 'symbol',
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">B</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bold</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">C</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">code</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">E</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">escape</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_LINK_COLORIZING_TAGS"></a><span class="summary-name">_LINK_COLORIZING_TAGS</span> = <code title="['link', 'uri']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">link</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">uri</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext-module.html#_BULLET_RE" class="summary-name" onclick="show_private();">_BULLET_RE</a> = <code title="re.compile(r'-( +|$)|(\d+\.)+( +|$)|@\w+( [^\{\}:\n]+)?:')">re.compile(r'-<code class="re-group">(</code> <code class="re-op">+</code><code class="re-op">|</code>$<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(</code>\d<code class="re-op">+</code>\.<code class="re-group">)</code><code class="re-op">+</code><code class="re-group">(</code> <code class="re-op">+</code><code class="re-op">|</code>$<code class="re-group">)</code><code class="re-op">|</code>@\w<code class="re-op">+</code><code class="re-group">(</code> <code class="re-group">[</code><code class="re-op">^</code>\{\}:<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_LIST_BULLET_RE"></a><span class="summary-name">_LIST_BULLET_RE</span> = <code title="re.compile(r'-( +|$)|(\d+\.)+( +|$)')">re.compile(r'-<code class="re-group">(</code> <code class="re-op">+</code><code class="re-op">|</code>$<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(</code>\d<code class="re-op">+</code>\.<code class="re-group">)</code><code class="re-op">+</code><code class="re-group">(</code> <code class="re-op">+</code><code class="re-op">|</code>$<code class="re-group">)</code>')</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_FIELD_BULLET_RE"></a><span class="summary-name">_FIELD_BULLET_RE</span> = <code title="re.compile(r'@\w+( [^\{\}:\n]+)?:')">re.compile(r'@\w<code class="re-op">+</code><code class="re-group">(</code> <code class="re-group">[</code><code class="re-op">^</code>\{\}:\n<code class="re-group">]</code><code class="re-op">+</code><code class="re-group">)</code><code class="re-op">?</code>:')</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_BRACE_RE"></a><span class="summary-name">_BRACE_RE</span> = <code title="re.compile(r'[\{\}]')">re.compile(r'<code class="re-group">[</code>\{\}<code class="re-group">]</code>')</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_TARGET_RE"></a><span class="summary-name">_TARGET_RE</span> = <code title="re.compile(r'^(.*?)\s*<(?:URI:|L:)?([^<>]+)>$')">re.compile(r'^<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>\s<code class="re-op">*</code><<code class="re-group">(?:</code>URI:<code class="re-op">|</code>L:<code class="re-group">)</code><code class="re-op">?</code><code class="re-group">(</code><code class="re-group">[</code><code class="re-op">^</code><><code class="re-group">]</code><code class="re-op">+</code><code class="re-group">)</code>>$')</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.epytext-module.html#GRAPH_TYPES" class="summary-name">GRAPH_TYPES</a> = <code title="['classtree', 'packagetree', 'importgraph', 'callgraph']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">classtree</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">packagetree</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">importgraph</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">cal</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="SYMBOL_TO_PLAINTEXT"></a><span class="summary-name">SYMBOL_TO_PLAINTEXT</span> = <code title="{'crarr': '\\'}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">crarr</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\\</code><code class="variable-quote">'</code><code class="variable-group">}</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="parse"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse</span>(<span class="sig-arg">str</span>,
<span class="sig-arg">errors</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#parse">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_2-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_2-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_2" name="call_graph_for_parse_2">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="359,6,522,38" />
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#to_dom" title="Token.to_dom()" alt="" coords="368,62,512,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_list" title="_add_list()" alt="" coords="388,118,492,150" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_para" title="_add_para()" alt="" coords="384,174,496,206" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_section" title="_add_section()" alt="" coords="374,230,507,262" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_pop_completed_blocks" title="_pop_completed_blocks()" alt="" coords="332,286,548,318" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_raise_graphs" title="_raise_graphs()" alt="" coords="371,342,510,374" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="387,398,494,430" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="208,202,283,234" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse_docstring" title="parse_docstring()" alt="" coords="7,202,159,234" />
</map>
<img src="call_graph_for_parse_2.gif" alt='' usemap="#call_graph_for_parse_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return a DOM tree encoding the contents of an epytext string. Any
errors generated during parsing will be stored in
<code>errors</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>str</code></strong> (<code>string</code>) - The epytext string to parse.</li>
<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a>) - A list where any errors generated during parsing will be stored.
If no list is specified, then fatal errors will generate
exceptions, and non-fatal errors will be ignored.</li>
</ul></dd>
<dt>Returns: <code>Element</code></dt>
<dd>a DOM tree encoding the contents of an epytext string.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="epydoc.markup.ParseError-class.html">ParseError</a></strong></code> - If <code>errors</code> is <code>None</code> and an error is
encountered while parsing.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_pop_completed_blocks"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_pop_completed_blocks</span>(<span class="sig-arg">token</span>,
<span class="sig-arg">stack</span>,
<span class="sig-arg">indent_stack</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_pop_completed_blocks">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__pop_completed_-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__pop_completed_-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__pop_completed_" name="call_graph_for__pop_completed_">
<area shape="rect" href="epydoc.markup.epytext-module.html#_pop_completed_blocks" title="_pop_completed_blocks()" alt="" coords="129,6,345,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="5,6,80,38" />
</map>
<img src="call_graph_for__pop_completed_.gif" alt='' usemap="#call_graph_for__pop_completed_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Pop any completed blocks off the stack. This includes any blocks that
we have dedented past, as well as any list item blocks that we've
dedented to. The top element on the stack should only be a list if we're
about to start a new list item (i.e., if the next token is a bullet).</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_add_list"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_add_list</span>(<span class="sig-arg">doc</span>,
<span class="sig-arg">bullet_token</span>,
<span class="sig-arg">stack</span>,
<span class="sig-arg">indent_stack</span>,
<span class="sig-arg">errors</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_add_list">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__add_list-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__add_list-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__add_list" name="call_graph_for__add_list">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="280,6,443,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_list" title="_add_list()" alt="" coords="128,6,232,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="5,6,80,38" />
</map>
<img src="call_graph_for__add_list.gif" alt='' usemap="#call_graph_for__add_list" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Add a new list item or field to the DOM tree, with the given bullet or
field tag. When necessary, create the associated list.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_tokenize_doctest"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_tokenize_doctest</span>(<span class="sig-arg">lines</span>,
<span class="sig-arg">start</span>,
<span class="sig-arg">block_indent</span>,
<span class="sig-arg">tokens</span>,
<span class="sig-arg">errors</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize_doctest">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize_docte-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__tokenize_docte-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize_docte" name="call_graph_for__tokenize_docte">
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#__init__" title="Token.__init__()" alt="" coords="383,6,529,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="7,6,113,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_doctest" title="_tokenize_doctest()" alt="" coords="163,6,333,38" />
</map>
<img src="call_graph_for__tokenize_docte.gif" alt='' usemap="#call_graph_for__tokenize_docte" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a> containing the doctest block starting at
<code>lines[start]</code>, and append it to <code>tokens</code>.
<code>block_indent</code> should be the indentation of the doctest block.
Any errors generated while tokenizing the doctest block will be appended
to <code>errors</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>lines</code></strong> (<code>list</code> of <code>string</code>) - The list of lines to be tokenized</li>
<li><strong class="pname"><code>start</code></strong> (<code>int</code>) - The index into <code>lines</code> of the first line of the
doctest block to be tokenized.</li>
<li><strong class="pname"><code>block_indent</code></strong> (<code>int</code>) - The indentation of <code>lines[start]</code>. This is the
indentation of the doctest block.</li>
<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a>) - A list where any errors generated during parsing will be stored.
If no list is specified, then errors will generate exceptions.</li>
<li><strong class="pname"><code>tokens</code></strong> (<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a>)</li>
</ul></dd>
<dt>Returns: <code>int</code></dt>
<dd>The line number of the first line following the doctest block.</dd>
</dl>
</td></tr></table>
</div>
<a name="_tokenize_literal"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_tokenize_literal</span>(<span class="sig-arg">lines</span>,
<span class="sig-arg">start</span>,
<span class="sig-arg">block_indent</span>,
<span class="sig-arg">tokens</span>,
<span class="sig-arg">errors</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize_literal">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize_liter-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__tokenize_liter-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize_liter" name="call_graph_for__tokenize_liter">
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#__init__" title="Token.__init__()" alt="" coords="372,6,519,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="7,6,113,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_literal" title="_tokenize_literal()" alt="" coords="163,6,323,38" />
</map>
<img src="call_graph_for__tokenize_liter.gif" alt='' usemap="#call_graph_for__tokenize_liter" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a> containing the literal block starting at
<code>lines[start]</code>, and append it to <code>tokens</code>.
<code>block_indent</code> should be the indentation of the literal block.
Any errors generated while tokenizing the literal block will be appended
to <code>errors</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>lines</code></strong> (<code>list</code> of <code>string</code>) - The list of lines to be tokenized</li>
<li><strong class="pname"><code>start</code></strong> (<code>int</code>) - The index into <code>lines</code> of the first line of the
literal block to be tokenized.</li>
<li><strong class="pname"><code>block_indent</code></strong> (<code>int</code>) - The indentation of <code>lines[start]</code>. This is the
indentation of the literal block.</li>
<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a>) - A list of the errors generated by parsing. Any new errors
generated while will tokenizing this paragraph will be appended
to this list.</li>
<li><strong class="pname"><code>tokens</code></strong> (<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a>)</li>
</ul></dd>
<dt>Returns: <code>int</code></dt>
<dd>The line number of the first line following the literal block.</dd>
</dl>
</td></tr></table>
</div>
<a name="_tokenize_listart"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_tokenize_listart</span>(<span class="sig-arg">lines</span>,
<span class="sig-arg">start</span>,
<span class="sig-arg">bullet_indent</span>,
<span class="sig-arg">tokens</span>,
<span class="sig-arg">errors</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize_listart">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize_lista-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__tokenize_lista-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize_lista" name="call_graph_for__tokenize_lista">
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#__init__" title="Token.__init__()" alt="" coords="372,6,519,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="7,6,113,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_listart" title="_tokenize_listart()" alt="" coords="163,6,323,38" />
</map>
<img src="call_graph_for__tokenize_lista.gif" alt='' usemap="#call_graph_for__tokenize_lista" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Construct <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a>s for the bullet and the first paragraph of the
list item (or field) starting at <code>lines[start]</code>, and append
them to <code>tokens</code>. <code>bullet_indent</code> should be the
indentation of the list item. Any errors generated while tokenizing will
be appended to <code>errors</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>lines</code></strong> (<code>list</code> of <code>string</code>) - The list of lines to be tokenized</li>
<li><strong class="pname"><code>start</code></strong> (<code>int</code>) - The index into <code>lines</code> of the first line of the list
item to be tokenized.</li>
<li><strong class="pname"><code>bullet_indent</code></strong> (<code>int</code>) - The indentation of <code>lines[start]</code>. This is the
indentation of the list item.</li>
<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a>) - A list of the errors generated by parsing. Any new errors
generated while will tokenizing this paragraph will be appended
to this list.</li>
<li><strong class="pname"><code>tokens</code></strong> (<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a>)</li>
</ul></dd>
<dt>Returns: <code>int</code></dt>
<dd>The line number of the first line following the list item's first
paragraph.</dd>
</dl>
</td></tr></table>
</div>
<a name="_tokenize_para"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_tokenize_para</span>(<span class="sig-arg">lines</span>,
<span class="sig-arg">start</span>,
<span class="sig-arg">para_indent</span>,
<span class="sig-arg">tokens</span>,
<span class="sig-arg">errors</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize_para">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize_para-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__tokenize_para-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize_para" name="call_graph_for__tokenize_para">
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#__init__" title="Token.__init__()" alt="" coords="362,6,508,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="7,6,114,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_para" title="_tokenize_para()" alt="" coords="163,6,312,38" />
</map>
<img src="call_graph_for__tokenize_para.gif" alt='' usemap="#call_graph_for__tokenize_para" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a> containing the paragraph starting at
<code>lines[start]</code>, and append it to <code>tokens</code>.
<code>para_indent</code> should be the indentation of the paragraph .
Any errors generated while tokenizing the paragraph will be appended to
<code>errors</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>lines</code></strong> (<code>list</code> of <code>string</code>) - The list of lines to be tokenized</li>
<li><strong class="pname"><code>start</code></strong> (<code>int</code>) - The index into <code>lines</code> of the first line of the
paragraph to be tokenized.</li>
<li><strong class="pname"><code>para_indent</code></strong> (<code>int</code>) - The indentation of <code>lines[start]</code>. This is the
indentation of the paragraph.</li>
<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a>) - A list of the errors generated by parsing. Any new errors
generated while will tokenizing this paragraph will be appended
to this list.</li>
<li><strong class="pname"><code>tokens</code></strong> (<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a>)</li>
</ul></dd>
<dt>Returns: <code>int</code></dt>
<dd>The line number of the first line following the paragraph.</dd>
</dl>
</td></tr></table>
</div>
<a name="_tokenize"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_tokenize</span>(<span class="sig-arg">str</span>,
<span class="sig-arg">errors</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_tokenize">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__tokenize-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__tokenize-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__tokenize" name="call_graph_for__tokenize">
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize" title="_tokenize()" alt="" coords="129,90,236,122" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_doctest" title="_tokenize_doctest()" alt="" coords="285,6,456,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_listart" title="_tokenize_listart()" alt="" coords="291,62,451,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_literal" title="_tokenize_literal()" alt="" coords="291,118,451,150" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_tokenize_para" title="_tokenize_para()" alt="" coords="296,174,445,206" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="5,90,80,122" />
</map>
<img src="call_graph_for__tokenize.gif" alt='' usemap="#call_graph_for__tokenize" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Split a given formatted docstring into an ordered list of
<code>Token</code>s, according to the epytext markup rules.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>str</code></strong> (<code>string</code>) - The epytext string</li>
<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a>) - A list where any errors generated during parsing will be stored.
If no list is specified, then errors will generate exceptions.</li>
</ul></dd>
<dt>Returns: <code>list</code> of <a href="epydoc.markup.epytext.Token-class.html"
class="link">Token</a></dt>
<dd>a list of the <code>Token</code>s that make up the given string.</dd>
</dl>
</td></tr></table>
</div>
<a name="_colorize"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_colorize</span>(<span class="sig-arg">doc</span>,
<span class="sig-arg">token</span>,
<span class="sig-arg">errors</span>,
<span class="sig-arg">tagName</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">para</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_colorize">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__colorize-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__colorize-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__colorize" name="call_graph_for__colorize">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="341,6,504,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_para" title="_add_para()" alt="" coords="16,34,128,66" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize" title="_colorize()" alt="" coords="188,62,292,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_section" title="_add_section()" alt="" coords="5,90,139,122" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize_graph" title="_colorize_graph()" alt="" coords="345,62,500,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize_link" title="_colorize_link()" alt="" coords="352,118,493,150" />
</map>
<img src="call_graph_for__colorize.gif" alt='' usemap="#call_graph_for__colorize" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Given a string containing the contents of a paragraph, produce a DOM
<code>Element</code> encoding that paragraph. Colorized regions are
represented using DOM <code>Element</code>s, and text is represented
using DOM <code>Text</code>s.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <code>string</code>) - A list of errors. Any newly generated errors will be appended to
this list.</li>
<li><strong class="pname"><code>tagName</code></strong> (<code>string</code>) - The element tag for the DOM <code>Element</code> that should be
generated.</li>
</ul></dd>
<dt>Returns: <code>Element</code></dt>
<dd>a DOM <code>Element</code> encoding the given paragraph.</dd>
</dl>
</td></tr></table>
</div>
<a name="_colorize_graph"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_colorize_graph</span>(<span class="sig-arg">doc</span>,
<span class="sig-arg">graph</span>,
<span class="sig-arg">token</span>,
<span class="sig-arg">end</span>,
<span class="sig-arg">errors</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#_colorize_graph">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__colorize_graph-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__colorize_graph-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__colorize_graph" name="call_graph_for__colorize_graph">
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize" title="_colorize()" alt="" coords="7,6,111,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize_graph" title="_colorize_graph()" alt="" coords="162,6,316,38" />
</map>
<img src="call_graph_for__colorize_graph.gif" alt='' usemap="#call_graph_for__colorize_graph" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Eg:</p>
<pre class="literalblock">
G{classtree}
G{classtree x, y, z}
G{importgraph}
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="to_epytext"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">to_epytext</span>(<span class="sig-arg">tree</span>,
<span class="sig-arg">indent</span>=<span class="sig-default">0</span>,
<span class="sig-arg">seclevel</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#to_epytext">source code</a></span>
</td>
</tr></table>
<p>Convert a DOM document encoding epytext back to an epytext string.
This is the inverse operation from <a
href="epydoc.markup.epytext-module.html#parse" class="link">parse</a>.
I.e., assuming there are no errors, the following is true:</p>
<ul>
<li>
<code>parse(to_epytext(tree)) == tree</code>
</li>
</ul>
<p>The inverse is true, except that whitespace, line wrapping, and
character escaping may be done differently.</p>
<ul>
<li>
<code>to_epytext(parse(str)) == str</code> (approximately)
</li>
</ul>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tree</code></strong> (<code>Element</code>) - A DOM document encoding of an epytext string.</li>
<li><strong class="pname"><code>indent</code></strong> (<code>int</code>) - The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.</li>
<li><strong class="pname"><code>seclevel</code></strong> (<code>int</code>) - The section level that <code>tree</code> appears at. This is
used to generate section headings.</li>
</ul></dd>
<dt>Returns: <code>string</code></dt>
<dd>The epytext string corresponding to <code>tree</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="to_plaintext"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">to_plaintext</span>(<span class="sig-arg">tree</span>,
<span class="sig-arg">indent</span>=<span class="sig-default">0</span>,
<span class="sig-arg">seclevel</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#to_plaintext">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_plaintext-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_to_plaintext-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_to_plaintext" name="call_graph_for_to_plaintext">
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext" title="ParsedEpytextDocstring.to_plaintext()" alt="" coords="7,30,313,62" />
<area shape="rect" href="epydoc.markup.epytext-module.html#to_plaintext" title="to_plaintext()" alt="" coords="363,30,485,62" />
<area shape="rect" href="epydoc.util-module.html#wordwrap" title="util.wordwrap()" alt="" coords="535,30,673,62" />
</map>
<img src="call_graph_for_to_plaintext.gif" alt='' usemap="#call_graph_for_to_plaintext" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Convert a DOM document encoding epytext to a string representation.
This representation is similar to the string generated by
<code>to_epytext</code>, but <code>to_plaintext</code> removes inline
markup, prints escaped characters in unescaped form, etc.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tree</code></strong> (<code>Element</code>) - A DOM document encoding of an epytext string.</li>
<li><strong class="pname"><code>indent</code></strong> (<code>int</code>) - The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.</li>
<li><strong class="pname"><code>seclevel</code></strong> (<code>int</code>) - The section level that <code>tree</code> appears at. This is
used to generate section headings.</li>
</ul></dd>
<dt>Returns: <code>string</code></dt>
<dd>The epytext string corresponding to <code>tree</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="to_debug"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">to_debug</span>(<span class="sig-arg">tree</span>,
<span class="sig-arg">indent</span>=<span class="sig-default">4</span>,
<span class="sig-arg">seclevel</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#to_debug">source code</a></span>
</td>
</tr></table>
<p>Convert a DOM document encoding epytext back to an epytext string,
annotated with extra debugging information. This function is similar to
<a href="epydoc.markup.epytext-module.html#to_epytext"
class="link">to_epytext</a>, but it adds explicit information about where
different blocks begin, along the left margin.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tree</code></strong> (<code>Element</code>) - A DOM document encoding of an epytext string.</li>
<li><strong class="pname"><code>indent</code></strong> (<code>int</code>) - The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.</li>
<li><strong class="pname"><code>seclevel</code></strong> (<code>int</code>) - The section level that <code>tree</code> appears at. This is
used to generate section headings.</li>
</ul></dd>
<dt>Returns: <code>string</code></dt>
<dd>The epytext string corresponding to <code>tree</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="pparse"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">pparse</span>(<span class="sig-arg">str</span>,
<span class="sig-arg">show_warnings</span>=<span class="sig-default">1</span>,
<span class="sig-arg">show_errors</span>=<span class="sig-default">1</span>,
<span class="sig-arg">stream</span>=<span class="sig-default">sys.stderr</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#pparse">source code</a></span>
</td>
</tr></table>
<p>Pretty-parse the string. This parses the string, and catches any
warnings or errors produced. Any warnings and errors are displayed, and
the resulting DOM parse structure is returned.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>str</code></strong> (<code>string</code>) - The string to parse.</li>
<li><strong class="pname"><code>show_warnings</code></strong> (<code>boolean</code>) - Whether or not to display non-fatal errors generated by parsing
<code>str</code>.</li>
<li><strong class="pname"><code>show_errors</code></strong> (<code>boolean</code>) - Whether or not to display fatal errors generated by parsing
<code>str</code>.</li>
<li><strong class="pname"><code>stream</code></strong> (<code>stream</code>) - The stream that warnings and errors should be written to.</li>
</ul></dd>
<dt>Returns: <code>Element</code></dt>
<dd>a DOM document encoding the contents of <code>str</code>.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>SyntaxError</strong></code> - If any fatal errors were encountered.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="parse_as_literal"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_as_literal</span>(<span class="sig-arg">str</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#parse_as_literal">source code</a></span>
</td>
</tr></table>
<p>Return a DOM document matching the epytext DTD, containing a single
literal block. That literal block will include the contents of the given
string. This method is typically used as a fall-back when the parser
fails.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>str</code></strong> (<code>string</code>) - The string which should be enclosed in a literal block.</li>
</ul></dd>
<dt>Returns: <code>Element</code></dt>
<dd>A DOM document containing <code>str</code> in a single literal
block.</dd>
</dl>
</td></tr></table>
</div>
<a name="parse_as_para"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_as_para</span>(<span class="sig-arg">str</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#parse_as_para">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_as_para-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_as_para-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_as_para" name="call_graph_for_parse_as_para">
<area shape="rect" href="epydoc.docstringparser-module.html#add_metadata_from_var" title="docstringparser.add_metadata_from_var()" alt="" coords="7,6,340,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse_as_para" title="parse_as_para()" alt="" coords="390,6,531,38" />
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="Element.__init__()" alt="" coords="579,6,742,38" />
</map>
<img src="call_graph_for_parse_as_para.gif" alt='' usemap="#call_graph_for_parse_as_para" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return a DOM document matching the epytext DTD, containing a single
paragraph. That paragraph will include the contents of the given string.
This can be used to wrap some forms of automatically generated
information (such as type names) in paragraphs.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>str</code></strong> (<code>string</code>) - The string which should be enclosed in a paragraph.</li>
</ul></dd>
<dt>Returns: <code>Element</code></dt>
<dd>A DOM document containing <code>str</code> in a single paragraph.</dd>
</dl>
</td></tr></table>
</div>
<a name="parse_docstring"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_docstring</span>(<span class="sig-arg">docstring</span>,
<span class="sig-arg">errors</span>,
<span class="sig-arg">**options</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#parse_docstring">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_docstring_2-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_docstring_2-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_docstring_2" name="call_graph_for_parse_docstring_2">
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__init__" title="ParsedEpytextDocstring.__init__()" alt="" coords="332,6,612,38" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="435,62,510,94" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse_docstring" title="parse_docstring()" alt="" coords="130,34,282,66" />
<area shape="rect" href="epydoc.markup-module.html#parse" title="parse()" alt="" coords="6,34,80,66" />
</map>
<img src="call_graph_for_parse_docstring_2.gif" alt='' usemap="#call_graph_for_parse_docstring_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Parse the given docstring, which is formatted using epytext; and
return a <code>ParsedDocstring</code> representation of its contents.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>docstring</code></strong> (<code>string</code>) - The docstring to parse</li>
<li><strong class="pname"><code>errors</code></strong> (<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a>) - A list where any errors generated during parsing will be stored.</li>
<li><strong class="pname"><code>options</code></strong> - Extra options. Unknown options are ignored. Currently, no extra
options are defined.</li>
</ul></dd>
<dt>Returns: <a href="epydoc.markup.ParsedDocstring-class.html"
class="link">ParsedDocstring</a></dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-VariablesDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="SYMBOLS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">SYMBOLS</h3>
A list of the of escape symbols that are supported by epydoc. Currently
the following symbols are supported:
<ul>
<li>
<code>S{<-}</code>=←;
</li>
<li>
<code>S{->}</code>=→;
</li>
<li>
<code>S{^}</code>=↑;
</li>
<li>
<code>S{v}</code>=↓;
</li>
<li>
<code>S{alpha}</code>=α;
</li>
<li>
<code>S{beta}</code>=β;
</li>
<li>
<code>S{gamma}</code>=γ;
</li>
<li>
<code>S{delta}</code>=δ;
</li>
<li>
<code>S{epsilon}</code>=ε;
</li>
<li>
<code>S{zeta}</code>=ζ;
</li>
<li>
<code>S{eta}</code>=η;
</li>
<li>
<code>S{theta}</code>=θ;
</li>
<li>
<code>S{iota}</code>=ι;
</li>
<li>
<code>S{kappa}</code>=κ;
</li>
<li>
<code>S{lambda}</code>=λ;
</li>
<li>
<code>S{mu}</code>=μ;
</li>
<li>
<code>S{nu}</code>=ν;
</li>
<li>
<code>S{xi}</code>=ξ;
</li>
<li>
<code>S{omicron}</code>=ο;
</li>
<li>
<code>S{pi}</code>=π;
</li>
<li>
<code>S{rho}</code>=ρ;
</li>
<li>
<code>S{sigma}</code>=σ;
</li>
<li>
<code>S{tau}</code>=τ;
</li>
<li>
<code>S{upsilon}</code>=υ;
</li>
<li>
<code>S{phi}</code>=φ;
</li>
<li>
<code>S{chi}</code>=χ;
</li>
<li>
<code>S{psi}</code>=ψ;
</li>
<li>
<code>S{omega}</code>=ω;
</li>
<li>
<code>S{Alpha}</code>=Α;
</li>
<li>
<code>S{Beta}</code>=Β;
</li>
<li>
<code>S{Gamma}</code>=Γ;
</li>
<li>
<code>S{Delta}</code>=Δ;
</li>
<li>
<code>S{Epsilon}</code>=Ε;
</li>
<li>
<code>S{Zeta}</code>=Ζ;
</li>
<li>
<code>S{Eta}</code>=Η;
</li>
<li>
<code>S{Theta}</code>=Θ;
</li>
<li>
<code>S{Iota}</code>=Ι;
</li>
<li>
<code>S{Kappa}</code>=Κ;
</li>
<li>
<code>S{Lambda}</code>=Λ;
</li>
<li>
<code>S{Mu}</code>=Μ;
</li>
<li>
<code>S{Nu}</code>=Ν;
</li>
<li>
<code>S{Xi}</code>=Ξ;
</li>
<li>
<code>S{Omicron}</code>=Ο;
</li>
<li>
<code>S{Pi}</code>=Π;
</li>
<li>
<code>S{Rho}</code>=Ρ;
</li>
<li>
<code>S{Sigma}</code>=Σ;
</li>
<li>
<code>S{Tau}</code>=Τ;
</li>
<li>
<code>S{Upsilon}</code>=Υ;
</li>
<li>
<code>S{Phi}</code>=Φ;
</li>
<li>
<code>S{Chi}</code>=Χ;
</li>
<li>
<code>S{Psi}</code>=Ψ;
</li>
<li>
<code>S{Omega}</code>=Ω;
</li>
<li>
<code>S{larr}</code>=←;
</li>
<li>
<code>S{rarr}</code>=→;
</li>
<li>
<code>S{uarr}</code>=↑;
</li>
<li>
<code>S{darr}</code>=↓;
</li>
<li>
<code>S{harr}</code>=↔;
</li>
<li>
<code>S{crarr}</code>=<span class="variable-linewrap"><img
src="crarr.png" alt="\" /></span>;
</li>
<li>
<code>S{lArr}</code>=⇐;
</li>
<li>
<code>S{rArr}</code>=⇒;
</li>
<li>
<code>S{uArr}</code>=⇑;
</li>
<li>
<code>S{dArr}</code>=⇓;
</li>
<li>
<code>S{hArr}</code>=⇔;
</li>
<li>
<code>S{copy}</code>=©;
</li>
<li>
<code>S{times}</code>=×;
</li>
<li>
<code>S{forall}</code>=∀;
</li>
<li>
<code>S{exist}</code>=∃;
</li>
<li>
<code>S{part}</code>=∂;
</li>
<li>
<code>S{empty}</code>=∅;
</li>
<li>
<code>S{isin}</code>=∈;
</li>
<li>
<code>S{notin}</code>=∉;
</li>
<li>
<code>S{ni}</code>=∋;
</li>
<li>
<code>S{prod}</code>=∏;
</li>
<li>
<code>S{sum}</code>=∑;
</li>
<li>
<code>S{prop}</code>=∝;
</li>
<li>
<code>S{infin}</code>=∞;
</li>
<li>
<code>S{ang}</code>=∠;
</li>
<li>
<code>S{and}</code>=∧;
</li>
<li>
<code>S{or}</code>=∨;
</li>
<li>
<code>S{cap}</code>=∩;
</li>
<li>
<code>S{cup}</code>=∪;
</li>
<li>
<code>S{int}</code>=∫;
</li>
<li>
<code>S{there4}</code>=∴;
</li>
<li>
<code>S{sim}</code>=∼;
</li>
<li>
<code>S{cong}</code>=≅;
</li>
<li>
<code>S{asymp}</code>=≈;
</li>
<li>
<code>S{ne}</code>=≠;
</li>
<li>
<code>S{equiv}</code>=≡;
</li>
<li>
<code>S{le}</code>=≤;
</li>
<li>
<code>S{ge}</code>=≥;
</li>
<li>
<code>S{sub}</code>=⊂;
</li>
<li>
<code>S{sup}</code>=⊃;
</li>
<li>
<code>S{nsub}</code>=⊄;
</li>
<li>
<code>S{sube}</code>=⊆;
</li>
<li>
<code>S{supe}</code>=⊇;
</li>
<li>
<code>S{oplus}</code>=⊕;
</li>
<li>
<code>S{otimes}</code>=⊗;
</li>
<li>
<code>S{perp}</code>=⊥;
</li>
<li>
<code>S{infinity}</code>=∞;
</li>
<li>
<code>S{integral}</code>=∫;
</li>
<li>
<code>S{product}</code>=∏;
</li>
<li>
<code>S{>=}</code>=≥;
</li>
<li>
<code>S{<=}</code>=≤
</li>
</ul>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string"><-</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">-></code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">^</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">v</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">alpha</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">beta</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">gamma</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">delta</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_SYMBOLS"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_SYMBOLS</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">-></code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string"><-</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string"><=</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">>=</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">Alpha</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">Beta</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">Chi</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">Delta</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_COLORIZING_TAGS"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_COLORIZING_TAGS</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">B</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">bold</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">C</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">code</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">E</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">escape</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">G</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">graph</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">I</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">italic</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">L</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">link</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">M</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">math</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">S</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">symbol</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_BULLET_RE"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_BULLET_RE</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
re.compile(r'-<code class="re-group">(</code> <code class="re-op">+</code><code class="re-op">|</code>$<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(</code>\d<code class="re-op">+</code>\.<code class="re-group">)</code><code class="re-op">+</code><code class="re-group">(</code> <code class="re-op">+</code><code class="re-op">|</code>$<code class="re-group">)</code><code class="re-op">|</code>@\w<code class="re-op">+</code><code class="re-group">(</code> <code class="re-group">[</code><code class="re-op">^</code>\{\}:\n<code class="re-group">]</code><code class="re-op">+</code><code class="re-group">)</code><code class="re-op">?</code>:')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="GRAPH_TYPES"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">GRAPH_TYPES</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">classtree</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">packagetree</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">importgraph</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">callgraph</code><code class="variable-quote">'</code><code class="variable-group">]</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:06:45 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
