Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > by-pkgid > 19bd24a6b0a164b1076d611371f5d099 > files > 175

epydoc-3.0.1-7mdv2010.2.noarch.rpm

<?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.restructuredtext._EpydocReader</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>&nbsp;&nbsp;&nbsp;<a
        href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;epydoc</a> ::
        <a href="epydoc.markup-module.html">Package&nbsp;markup</a> ::
        <a href="epydoc.markup.restructuredtext-module.html">Module&nbsp;restructuredtext</a> ::
        Class&nbsp;_EpydocReader
      </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&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="epydoc.markup.restructuredtext._EpydocReader-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class _EpydocReader</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_EpydocReader">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_epydoc_m_23" name="uml_class_diagram_for_epydoc_m_23">
<area shape="rect" href="javascript:void(0);" title="Name of the component type (&#39;reader&#39;, &#39;parser&#39;, &#39;writer&#39;)." alt="" coords="119,215,306,233" />
<area shape="rect" href="javascript:void(0);" title="Parse self.input into a document tree." alt="" coords="119,236,306,255" />
<area shape="rect" href="javascript:void(0);" title="Set self.parser by name." alt="" coords="119,255,306,273" />
<area shape="rect" href="javascript:void(0);" title="Abstract base class for docutils Readers." alt="" coords="107,192,318,280" />
<area shape="rect" href="javascript:void(0);" title="The name of the config file section specific to this component (lowercase, no brackets)." alt="" coords="107,321,318,340" />
<area shape="rect" href="javascript:void(0);" title="A list of names of config file sections that are to be applied before config_section, in order (from general to specific)." alt="" coords="107,340,318,359" />
<area shape="rect" href="javascript:void(0);" title="docutils.readers.standalone.Reader.document" alt="" coords="107,359,318,377" />
<area shape="rect" href="javascript:void(0);" title="Names for this component." alt="" coords="107,377,318,396" />
<area shape="rect" href="javascript:void(0);" title="docutils.readers.standalone.Reader" alt="" coords="95,299,330,411" />
<area shape="rect" href="javascript:void(0);" title="Is format supported by this component?" alt="" coords="146,148,279,167" />
<area shape="rect" href="javascript:void(0);" title="Base class for Docutils components." alt="" coords="134,117,291,173" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#default_transforms" title="epydoc.markup.restructuredtext._EpydocReader.default_transforms" alt="" coords="148,559,276,577" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#v" title="epydoc.markup.restructuredtext._EpydocReader.v" alt="" coords="148,577,276,596" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#get_transforms" title="Transforms required by this class." alt="" coords="148,599,276,617" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#__init__" title="Initialize the Reader instance." alt="" coords="148,617,276,636" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#new_document" title="Create and return a new empty document tree (root node)." alt="" coords="148,636,276,655" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#report" title="epydoc.markup.restructuredtext._EpydocReader.report" alt="" coords="148,655,276,673" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html" title="A reader that captures all errors that are generated by parsing, and appends them to a list." alt="" coords="136,536,288,680" />
<area shape="rect" href="epydoc.docwriter.xlink.ApiLinkReader&#45;class.html#settings_spec" title="The option parser configuration." alt="" coords="56,452,368,471" />
<area shape="rect" href="epydoc.docwriter.xlink.ApiLinkReader&#45;class.html#read" title="epydoc.docwriter.xlink.ApiLinkReader.read" alt="" coords="56,473,368,492" />
<area shape="rect" href="epydoc.docwriter.xlink.ApiLinkReader&#45;class.html#read_configuration" title="Read the configuration for the configured URL resolver." alt="" coords="56,492,368,511" />
<area shape="rect" href="epydoc.docwriter.xlink.ApiLinkReader&#45;class.html" title="A Docutils standalone reader allowing external documentation links." alt="" coords="44,429,380,517" />
<area shape="rect" href="javascript:void(0);" title="A dictionary of defaults for settings not in settings_spec (internal settings, intended to be inaccessible by command&#45;line and config file)." alt="" coords="18,28,180,47" />
<area shape="rect" href="javascript:void(0);" title="A dictionary of auxiliary defaults, to override defaults for settings defined in other components." alt="" coords="18,47,180,65" />
<area shape="rect" href="javascript:void(0);" title="Settings containing filesystem paths." alt="" coords="18,65,180,84" />
<area shape="rect" href="javascript:void(0);" title="Runtime setting specification base class." alt="" coords="6,5,192,99" />
<area shape="rect" href="javascript:void(0);" title="List of functions to try to resolve unknown references." alt="" coords="234,47,418,65" />
<area shape="rect" href="javascript:void(0);" title="Runtime transform specification base class." alt="" coords="222,24,430,80" />
</map>
  <img src="uml_class_diagram_for_epydoc_m_23.gif" alt='' usemap="#uml_class_diagram_for_epydoc_m_23" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>A reader that captures all errors that are generated by parsing, and 
  appends them to a list.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></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">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         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">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="epydoc.markup.restructuredtext._EpydocReader-class.html#get_transforms" class="summary-sig-name">get_transforms</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Transforms required by this class.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_EpydocReader.get_transforms">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_transforms-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_get_transforms-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_get_transforms" name="call_graph_for_get_transforms">
<area shape="rect" href="javascript:void(0);" title="docutils.readers.standalone.Reader.get_transforms()" alt="" coords="200,6,611,38" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#get_transforms" title="get_transforms()" alt="" coords="7,6,151,38" />
</map>
  <img src="call_graph_for_get_transforms.gif" alt='' usemap="#call_graph_for_get_transforms" 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">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="epydoc.markup.restructuredtext._EpydocReader-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">errors</span>)</span><br />
      Initialize the Reader instance.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_EpydocReader.__init__">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___46-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for___init___46-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for___init___46" name="call_graph_for___init___46">
<area shape="rect" href="epydoc.docwriter.xlink.ApiLinkReader&#45;class.html#__init__" title="docwriter.xlink.ApiLinkReader.__init__()" alt="" coords="355,6,691,38" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#__init__" title="__init__()" alt="" coords="209,6,305,38" />
<area shape="rect" href="epydoc.markup.restructuredtext&#45;module.html#parse_docstring" title="parse_docstring()" alt="" coords="7,6,159,38" />
</map>
  <img src="call_graph_for___init___46.gif" alt='' usemap="#call_graph_for___init___46" 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">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="epydoc.markup.restructuredtext._EpydocReader-class.html#new_document" class="summary-sig-name">new_document</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Create and return a new empty document tree (root node).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_EpydocReader.new_document">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_new_document-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_new_document-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_new_document" name="call_graph_for_new_document">
<area shape="rect" href="javascript:void(0);" title="docutils.readers.Reader.parse()" alt="" coords="5,6,259,38" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#new_document" title="new_document()" alt="" coords="308,6,455,38" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.attach_observer()" alt="" coords="504,6,827,38" />
</map>
  <img src="call_graph_for_new_document.gif" alt='' usemap="#call_graph_for_new_document" 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">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="report"></a><span class="summary-sig-name">report</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">error</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_EpydocReader.report">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.docwriter.xlink.ApiLinkReader-class.html">docwriter.xlink.ApiLinkReader</a></code></b>:
      <code><a href="epydoc.docwriter.xlink.ApiLinkReader-class.html#read">read</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>docutils.readers.Reader</code></b>:
      <code>parse</code>,
      <code>set_parser</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>docutils.Component</code></b>:
      <code>supports</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS METHODS ==================== -->
<a name="section-ClassMethods"></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">Class Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.docwriter.xlink.ApiLinkReader-class.html">docwriter.xlink.ApiLinkReader</a></code></b>:
      <code><a href="epydoc.docwriter.xlink.ApiLinkReader-class.html#read_configuration">read_configuration</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         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">&nbsp;</span>
    </td><td class="summary">
        <a name="default_transforms"></a><span class="summary-name">default_transforms</span> = <code title="list(ApiLinkReader.default_transforms)">list(ApiLinkReader.default_transforms)</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="v"></a><span class="summary-name">v</span> = <code title="'5'"><code class="variable-quote">'</code><code class="variable-string">5</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.docwriter.xlink.ApiLinkReader-class.html">docwriter.xlink.ApiLinkReader</a></code></b>:
      <code><a href="epydoc.docwriter.xlink.ApiLinkReader-class.html#settings_spec">settings_spec</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.docwriter.xlink.ApiLinkReader-class.html">docwriter.xlink.ApiLinkReader</a></code></b> (private):
      <code><a href="epydoc.docwriter.xlink.ApiLinkReader-class.html#_conf" onclick="show_private();">_conf</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>docutils.readers.standalone.Reader</code></b>:
      <code>config_section</code>,
      <code>config_section_dependencies</code>,
      <code>document</code>,
      <code>supported</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>docutils.readers.Reader</code></b>:
      <code>component_type</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>docutils.SettingsSpec</code></b>:
      <code>relative_path_settings</code>,
      <code>settings_default_overrides</code>,
      <code>settings_defaults</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>docutils.TransformSpec</code></b>:
      <code>unknown_reference_resolvers</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></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">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="get_transforms"></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">get_transforms</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_EpydocReader.get_transforms">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_transforms-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for_get_transforms-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_get_transforms" name="call_graph_for_get_transforms">
<area shape="rect" href="javascript:void(0);" title="docutils.readers.standalone.Reader.get_transforms()" alt="" coords="200,6,611,38" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#get_transforms" title="get_transforms()" alt="" coords="7,6,151,38" />
</map>
  <img src="call_graph_for_get_transforms.gif" alt='' usemap="#call_graph_for_get_transforms" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  Transforms required by this class.  Override in subclasses.
  <dl class="fields">
    <dt>Overrides:
        docutils.TransformSpec.get_transforms
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="__init__"></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">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">errors</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_EpydocReader.__init__">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___46-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for___init___46-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for___init___46" name="call_graph_for___init___46">
<area shape="rect" href="epydoc.docwriter.xlink.ApiLinkReader&#45;class.html#__init__" title="docwriter.xlink.ApiLinkReader.__init__()" alt="" coords="355,6,691,38" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#__init__" title="__init__()" alt="" coords="209,6,305,38" />
<area shape="rect" href="epydoc.markup.restructuredtext&#45;module.html#parse_docstring" title="parse_docstring()" alt="" coords="7,6,159,38" />
</map>
  <img src="call_graph_for___init___46.gif" alt='' usemap="#call_graph_for___init___46" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  <p>Initialize the Reader instance.</p>
<p>Several instance attributes are defined with dummy initial values.
Subclasses may use these attributes as they wish.</p>
  <dl class="fields">
    <dt>Overrides:
        docutils.readers.Reader.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="new_document"></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">new_document</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#_EpydocReader.new_document">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_new_document-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for_new_document-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_new_document" name="call_graph_for_new_document">
<area shape="rect" href="javascript:void(0);" title="docutils.readers.Reader.parse()" alt="" coords="5,6,259,38" />
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocReader&#45;class.html#new_document" title="new_document()" alt="" coords="308,6,455,38" />
<area shape="rect" href="javascript:void(0);" title="docutils.utils.Reporter.attach_observer()" alt="" coords="504,6,827,38" />
</map>
  <img src="call_graph_for_new_document.gif" alt='' usemap="#call_graph_for_new_document" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  Create and return a new empty document tree (root node).
  <dl class="fields">
    <dt>Overrides:
        docutils.readers.Reader.new_document
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </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>&nbsp;&nbsp;&nbsp;<a
        href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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:08:56 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>