<?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</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 restructuredtext
</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.restructuredtext-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.markup.restructuredtext-module.html">Module epydoc.markup.restructuredtext</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># rst.py: ReStructuredText docstring parsing</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Edward Loper</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Created [06/28/03 02:52 AM]</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># $Id: restructuredtext.py 1661 2007-11-07 12:59:34Z dvarrazzo $</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring">Epydoc parser for ReStructuredText strings. ReStructuredText is the</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">standard markup language used by the Docutils project.</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring">L{parse_docstring()} provides the primary interface to this module; it</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">returns a L{ParsedRstDocstring}, which supports all of the methods</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">defined by L{ParsedDocstring}.</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring">L{ParsedRstDocstring} is basically just a L{ParsedDocstring} wrapper</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">for the C{docutils.nodes.document} class.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">Creating C{ParsedRstDocstring}s</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">===============================</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring">C{ParsedRstDocstring}s are created by the C{parse_document} function,</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring">using the C{docutils.core.publish_string()} method, with the following</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring">helpers:</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring"> - An L{_EpydocReader} is used to capture all error messages as it</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring"> parses the docstring.</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring"> - A L{_DocumentPseudoWriter} is used to extract the document itself,</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring"> without actually writing any output. The document is saved for</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring"> further processing. The settings for the writer are copied from</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"> C{docutils.writers.html4css1.Writer}, since those settings will</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"> be used when we actually write the docstring to html.</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring">Using C{ParsedRstDocstring}s</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring">============================</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring">C{ParsedRstDocstring}s support all of the methods defined by</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring">C{ParsedDocstring}; but only the following four methods have</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring">non-default behavior:</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> - L{to_html()<ParsedRstDocstring.to_html>} uses an</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> L{_EpydocHTMLTranslator} to translate the C{ParsedRstDocstring}'s</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"> document into an HTML segment.</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> - L{split_fields()<ParsedRstDocstring.split_fields>} uses a</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"> L{_SplitFieldsTranslator} to divide the C{ParsedRstDocstring}'s</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> document into its main body and its fields. Special handling</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> is done to account for consolidated fields.</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> - L{summary()<ParsedRstDocstring.summary>} uses a</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> L{_SummaryExtractor} to extract the first sentence from</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"> the C{ParsedRstDocstring}'s document.</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> - L{to_plaintext()<ParsedRstDocstring.to_plaintext>} uses</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> C{document.astext()} to convert the C{ParsedRstDocstring}'s</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> document to plaintext.</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring">@todo: Add ParsedRstDocstring.to_latex()</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring">@var CONSOLIDATED_FIELDS: A dictionary encoding the set of</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring">'consolidated fields' that can be used. Each consolidated field is</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring">marked by a single tag, and contains a single bulleted list, where</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring">each list item starts with an identifier, marked as interpreted text</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring">(C{`...`}). This module automatically splits these consolidated</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring">fields into individual fields. The keys of C{CONSOLIDATED_FIELDS} are</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring">the names of possible consolidated fields; and the values are the</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring">names of the field tags that should be used for individual entries in</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring">the list.</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-comment"># Imports</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">re</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.path=epydoc.apidoc.ModuleDoc-class.html#path"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-0', 'path', 'link-0');">path</a></tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">xml</tt><tt class="py-op">.</tt><tt class="py-name">dom</tt><tt class="py-op">.</tt><tt class="py-name">minidom</tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">core</tt> <tt class="py-keyword">import</tt> <tt class="py-name">publish_string</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">writers</tt> <tt class="py-keyword">import</tt> <tt class="py-name">Writer</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">writers</tt><tt class="py-op">.</tt><tt class="py-name">html4css1</tt> <tt class="py-keyword">import</tt> <tt class="py-name">HTMLTranslator</tt><tt class="py-op">,</tt> <tt class="py-name">Writer</tt> <tt class="py-name">as</tt> <tt id="link-1" class="py-name" targets="Class epydoc.docwriter.html.HTMLWriter=epydoc.docwriter.html.HTMLWriter-class.html"><a title="epydoc.docwriter.html.HTMLWriter" class="py-name" href="#" onclick="return doclink('link-1', 'HTMLWriter', 'link-1');">HTMLWriter</a></tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">writers</tt><tt class="py-op">.</tt><tt class="py-name">latex2e</tt> <tt class="py-keyword">import</tt> <tt class="py-name">LaTeXTranslator</tt><tt class="py-op">,</tt> <tt class="py-name">Writer</tt> <tt class="py-name">as</tt> <tt class="py-name">LaTeXWriter</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">readers</tt><tt class="py-op">.</tt><tt class="py-name">standalone</tt> <tt class="py-keyword">import</tt> <tt class="py-name">Reader</tt> <tt class="py-name">as</tt> <tt class="py-name">StandaloneReader</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">utils</tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Method epydoc.markup.restructuredtext._EpydocReader.new_document()=epydoc.markup.restructuredtext._EpydocReader-class.html#new_document"><a title="epydoc.markup.restructuredtext._EpydocReader.new_document" class="py-name" href="#" onclick="return doclink('link-2', 'new_document', 'link-2');">new_document</a></tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt> <tt class="py-keyword">import</tt> <tt class="py-name">NodeVisitor</tt><tt class="py-op">,</tt> <tt class="py-name">Text</tt><tt class="py-op">,</tt> <tt class="py-name">SkipChildren</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt> <tt class="py-keyword">import</tt> <tt class="py-name">SkipNode</tt><tt class="py-op">,</tt> <tt class="py-name">TreeCopyVisitor</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">frontend</tt> <tt class="py-keyword">import</tt> <tt class="py-name">OptionParser</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">parsers</tt><tt class="py-op">.</tt><tt class="py-name">rst</tt> <tt class="py-keyword">import</tt> <tt class="py-name">directives</tt><tt class="py-op">,</tt> <tt class="py-name">roles</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">transforms</tt><tt class="py-op">.</tt><tt class="py-name">frontmatter</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">transforms</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">utils</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-3', 'epydoc', 'link-3');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Module epydoc.compat=epydoc.compat-module.html"><a title="epydoc.compat" class="py-name" href="#" onclick="return doclink('link-4', 'compat', 'link-4');">compat</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> <tt class="py-comment"># Backwards compatibility</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-5" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-5', 'epydoc', 'link-3');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Package epydoc.markup=epydoc.markup-module.html,Method epydoc.markup.doctest.DoctestColorizer.markup()=epydoc.markup.doctest.DoctestColorizer-class.html#markup,Method epydoc.markup.doctest.HTMLDoctestColorizer.markup()=epydoc.markup.doctest.HTMLDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.LaTeXDoctestColorizer.markup()=epydoc.markup.doctest.LaTeXDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.XMLDoctestColorizer.markup()=epydoc.markup.doctest.XMLDoctestColorizer-class.html#markup"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-6', 'markup', 'link-6');">markup</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-7" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-7', 'epydoc', 'link-3');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-8', 'apidoc', 'link-8');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-9" class="py-name" targets="Class epydoc.apidoc.ModuleDoc=epydoc.apidoc.ModuleDoc-class.html"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-9', 'ModuleDoc', 'link-9');">ModuleDoc</a></tt><tt class="py-op">,</tt> <tt id="link-10" class="py-name" targets="Class epydoc.apidoc.ClassDoc=epydoc.apidoc.ClassDoc-class.html"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-10', 'ClassDoc', 'link-10');">ClassDoc</a></tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-11" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-11', 'epydoc', 'link-3');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Package epydoc.docwriter=epydoc.docwriter-module.html"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-12', 'docwriter', 'link-12');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Module epydoc.docwriter.dotgraph=epydoc.docwriter.dotgraph-module.html,Class epydoc.markup.restructuredtext.dotgraph=epydoc.markup.restructuredtext.dotgraph-class.html"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-13', 'dotgraph', 'link-13');">dotgraph</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-14" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-14', 'epydoc', 'link-3');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-15', 'docwriter', 'link-12');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Module epydoc.docwriter.xlink=epydoc.docwriter.xlink-module.html"><a title="epydoc.docwriter.xlink" class="py-name" href="#" onclick="return doclink('link-16', 'xlink', 'link-16');">xlink</a></tt> <tt class="py-keyword">import</tt> <tt id="link-17" class="py-name" targets="Class epydoc.docwriter.xlink.ApiLinkReader=epydoc.docwriter.xlink.ApiLinkReader-class.html"><a title="epydoc.docwriter.xlink.ApiLinkReader" class="py-name" href="#" onclick="return doclink('link-17', 'ApiLinkReader', 'link-17');">ApiLinkReader</a></tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-18" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-18', 'epydoc', 'link-3');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-19', 'markup', 'link-6');">markup</a></tt><tt class="py-op">.</tt><tt id="link-20" class="py-name" targets="Module epydoc.markup.doctest=epydoc.markup.doctest-module.html"><a title="epydoc.markup.doctest" class="py-name" href="#" onclick="return doclink('link-20', 'doctest', 'link-20');">doctest</a></tt> <tt class="py-keyword">import</tt> <tt id="link-21" class="py-name" targets="Function epydoc.markup.doctest.doctest_to_html()=epydoc.markup.doctest-module.html#doctest_to_html"><a title="epydoc.markup.doctest.doctest_to_html" class="py-name" href="#" onclick="return doclink('link-21', 'doctest_to_html', 'link-21');">doctest_to_html</a></tt><tt class="py-op">,</tt> <tt id="link-22" class="py-name" targets="Function epydoc.markup.doctest.doctest_to_latex()=epydoc.markup.doctest-module.html#doctest_to_latex"><a title="epydoc.markup.doctest.doctest_to_latex" class="py-name" href="#" onclick="return doclink('link-22', 'doctest_to_latex', 'link-22');">doctest_to_latex</a></tt><tt class="py-op">,</tt> \ </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt id="link-23" class="py-name" targets="Class epydoc.markup.doctest.HTMLDoctestColorizer=epydoc.markup.doctest.HTMLDoctestColorizer-class.html"><a title="epydoc.markup.doctest.HTMLDoctestColorizer" class="py-name" href="#" onclick="return doclink('link-23', 'HTMLDoctestColorizer', 'link-23');">HTMLDoctestColorizer</a></tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-comment">#: A dictionary whose keys are the "consolidated fields" that are</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#: recognized by epydoc; and whose values are the corresponding epydoc</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#: field names that should be used for the individual fields.</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-24" class="py-name" targets="Variable epydoc.markup.restructuredtext.CONSOLIDATED_FIELDS=epydoc.markup.restructuredtext-module.html#CONSOLIDATED_FIELDS"><a title="epydoc.markup.restructuredtext.CONSOLIDATED_FIELDS" class="py-name" href="#" onclick="return doclink('link-24', 'CONSOLIDATED_FIELDS', 'link-24');">CONSOLIDATED_FIELDS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-string">'parameters'</tt><tt class="py-op">:</tt> <tt class="py-string">'param'</tt><tt class="py-op">,</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt class="py-string">'arguments'</tt><tt class="py-op">:</tt> <tt class="py-string">'arg'</tt><tt class="py-op">,</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-string">'exceptions'</tt><tt class="py-op">:</tt> <tt class="py-string">'except'</tt><tt class="py-op">,</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-string">'variables'</tt><tt class="py-op">:</tt> <tt class="py-string">'var'</tt><tt class="py-op">,</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-string">'ivariables'</tt><tt class="py-op">:</tt> <tt class="py-string">'ivar'</tt><tt class="py-op">,</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-string">'cvariables'</tt><tt class="py-op">:</tt> <tt class="py-string">'cvar'</tt><tt class="py-op">,</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-string">'groups'</tt><tt class="py-op">:</tt> <tt class="py-string">'group'</tt><tt class="py-op">,</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt class="py-string">'types'</tt><tt class="py-op">:</tt> <tt class="py-string">'type'</tt><tt class="py-op">,</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-string">'keywords'</tt><tt class="py-op">:</tt> <tt class="py-string">'keyword'</tt><tt class="py-op">,</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-comment">#: A list of consolidated fields whose bodies may be specified using a</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#: definition list, rather than a bulleted list. For these fields, the</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#: 'classifier' for each term in the definition list is translated into</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#: a @type field.</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-25" class="py-name" targets="Variable epydoc.markup.restructuredtext.CONSOLIDATED_DEFLIST_FIELDS=epydoc.markup.restructuredtext-module.html#CONSOLIDATED_DEFLIST_FIELDS"><a title="epydoc.markup.restructuredtext.CONSOLIDATED_DEFLIST_FIELDS" class="py-name" href="#" onclick="return doclink('link-25', 'CONSOLIDATED_DEFLIST_FIELDS', 'link-25');">CONSOLIDATED_DEFLIST_FIELDS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'param'</tt><tt class="py-op">,</tt> <tt class="py-string">'arg'</tt><tt class="py-op">,</tt> <tt class="py-string">'var'</tt><tt class="py-op">,</tt> <tt class="py-string">'ivar'</tt><tt class="py-op">,</tt> <tt class="py-string">'cvar'</tt><tt class="py-op">,</tt> <tt class="py-string">'keyword'</tt><tt class="py-op">]</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> </tt>
<a name="parse_docstring"></a><div id="parse_docstring-def"><a name="L116"></a><tt class="py-lineno">116</tt> <a class="py-toggle" href="#" id="parse_docstring-toggle" onclick="return toggle('parse_docstring');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#parse_docstring">parse_docstring</a><tt class="py-op">(</tt><tt class="py-param">docstring</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_docstring-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="parse_docstring-expanded"><a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> Parse the given docstring, which is formatted using</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> ReStructuredText; and return a L{ParsedDocstring} representation</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> of its contents.</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"> @param docstring: The docstring to parse</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"> @type docstring: C{string}</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list where any errors generated during parsing</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-docstring"> will be stored.</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of L{ParseError}</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"> @param options: Extra options. Unknown options are ignored.</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> Currently, no extra options are defined.</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{ParsedDocstring}</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-name">writer</tt> <tt class="py-op">=</tt> <tt id="link-26" class="py-name" targets="Class epydoc.markup.restructuredtext._DocumentPseudoWriter=epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html"><a title="epydoc.markup.restructuredtext._DocumentPseudoWriter" class="py-name" href="#" onclick="return doclink('link-26', '_DocumentPseudoWriter', 'link-26');">_DocumentPseudoWriter</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-name">reader</tt> <tt class="py-op">=</tt> <tt id="link-27" class="py-name" targets="Class epydoc.markup.restructuredtext._EpydocReader=epydoc.markup.restructuredtext._EpydocReader-class.html"><a title="epydoc.markup.restructuredtext._EpydocReader" class="py-name" href="#" onclick="return doclink('link-27', '_EpydocReader', 'link-27');">_EpydocReader</a></tt><tt class="py-op">(</tt><tt class="py-name">errors</tt><tt class="py-op">)</tt> <tt class="py-comment"># Outputs errors to the list.</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-name">publish_string</tt><tt class="py-op">(</tt><tt id="link-28" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring=epydoc.apidoc.APIDoc-class.html#docstring"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-28', 'docstring', 'link-28');">docstring</a></tt><tt class="py-op">,</tt> <tt class="py-name">writer</tt><tt class="py-op">=</tt><tt class="py-name">writer</tt><tt class="py-op">,</tt> <tt class="py-name">reader</tt><tt class="py-op">=</tt><tt class="py-name">reader</tt><tt class="py-op">,</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt class="py-name">settings_overrides</tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-string">'report_level'</tt><tt class="py-op">:</tt><tt class="py-number">10000</tt><tt class="py-op">,</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt class="py-string">'halt_level'</tt><tt class="py-op">:</tt><tt class="py-number">10000</tt><tt class="py-op">,</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> <tt class="py-string">'warning_stream'</tt><tt class="py-op">:</tt><tt class="py-name">None</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-29" class="py-name" targets="Class epydoc.markup.restructuredtext.ParsedRstDocstring=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html"><a title="epydoc.markup.restructuredtext.ParsedRstDocstring" class="py-name" href="#" onclick="return doclink('link-29', 'ParsedRstDocstring', 'link-29');">ParsedRstDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">writer</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name" targets="Function epydoc.gui.document()=epydoc.gui-module.html#document"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-30', 'document', 'link-30');">document</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> </tt>
<a name="OptimizedReporter"></a><div id="OptimizedReporter-def"><a name="L138"></a><tt class="py-lineno">138</tt> <a class="py-toggle" href="#" id="OptimizedReporter-toggle" onclick="return toggle('OptimizedReporter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.OptimizedReporter-class.html">OptimizedReporter</a><tt class="py-op">(</tt><tt class="py-base-class">docutils</tt><tt class="py-op">.</tt><tt class="py-base-class">utils</tt><tt class="py-op">.</tt><tt class="py-base-class">Reporter</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="OptimizedReporter-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="OptimizedReporter-expanded"><a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-docstring">"""A reporter that ignores all debug messages. This is used to</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"><tt class="py-docstring"> shave a couple seconds off of epydoc's run time, since docutils</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"><tt class="py-docstring"> isn't very fast about processing its own debug messages."""</tt> </tt>
<a name="OptimizedReporter.debug"></a><div id="OptimizedReporter.debug-def"><a name="L142"></a><tt class="py-lineno">142</tt> <a class="py-toggle" href="#" id="OptimizedReporter.debug-toggle" onclick="return toggle('OptimizedReporter.debug');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.OptimizedReporter-class.html#debug">debug</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div></div><a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"> </tt>
<a name="ParsedRstDocstring"></a><div id="ParsedRstDocstring-def"><a name="L144"></a><tt class="py-lineno">144</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring-toggle" onclick="return toggle('ParsedRstDocstring');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html">ParsedRstDocstring</a><tt class="py-op">(</tt><tt class="py-base-class">ParsedDocstring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedRstDocstring-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ParsedRstDocstring-expanded"><a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"> An encoded version of a ReStructuredText docstring. The contents</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> of the docstring are encoded in the L{_document} instance</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> variable.</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"> @ivar _document: A ReStructuredText document, encoding the</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-docstring"> docstring.</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-docstring"> @type _document: C{docutils.nodes.document}</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="ParsedRstDocstring.__init__"></a><div id="ParsedRstDocstring.__init__-def"><a name="L154"></a><tt class="py-lineno">154</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring.__init__-toggle" onclick="return toggle('ParsedRstDocstring.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">document</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedRstDocstring.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ParsedRstDocstring.__init__-expanded"><a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-docstring"> @type document: C{docutils.nodes.document}</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt> <tt class="py-op">=</tt> <tt id="link-31" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-31', 'document', 'link-30');">document</a></tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-comment"># The default document reporter and transformer are not</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># pickle-able; so replace them with stubs that are.</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-32" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-32', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">reporter</tt> <tt class="py-op">=</tt> <tt id="link-33" class="py-name" targets="Class epydoc.markup.restructuredtext.OptimizedReporter=epydoc.markup.restructuredtext.OptimizedReporter-class.html"><a title="epydoc.markup.restructuredtext.OptimizedReporter" class="py-name" href="#" onclick="return doclink('link-33', 'OptimizedReporter', 'link-33');">OptimizedReporter</a></tt><tt class="py-op">(</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> <tt id="link-34" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-34', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">reporter</tt><tt class="py-op">.</tt><tt class="py-name">source</tt><tt class="py-op">,</tt> <tt class="py-string">'SEVERE'</tt><tt class="py-op">,</tt> <tt class="py-string">'SEVERE'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt id="link-35" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-35', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">transformer</tt> <tt class="py-op">=</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">transforms</tt><tt class="py-op">.</tt><tt class="py-name">Transformer</tt><tt class="py-op">(</tt><tt id="link-36" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-36', 'document', 'link-30');">document</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> </tt>
<a name="ParsedRstDocstring.split_fields"></a><div id="ParsedRstDocstring.split_fields-def"><a name="L166"></a><tt class="py-lineno">166</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring.split_fields-toggle" onclick="return toggle('ParsedRstDocstring.split_fields');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#split_fields">split_fields</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedRstDocstring.split_fields-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ParsedRstDocstring.split_fields-expanded"><a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"> <tt class="py-comment"># Inherit docs</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">errors</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">errors</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"> <tt class="py-name">visitor</tt> <tt class="py-op">=</tt> <tt id="link-37" class="py-name" targets="Class epydoc.markup.restructuredtext._SplitFieldsTranslator=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator" class="py-name" href="#" onclick="return doclink('link-37', '_SplitFieldsTranslator', 'link-37');">_SplitFieldsTranslator</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">.</tt><tt class="py-name">walk</tt><tt class="py-op">(</tt><tt class="py-name">visitor</tt><tt class="py-op">)</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">visitor</tt><tt class="py-op">.</tt><tt class="py-name">fields</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">visitor</tt><tt class="py-op">.</tt><tt class="py-name">fields</tt> </tt>
</div><a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> </tt>
<a name="ParsedRstDocstring.summary"></a><div id="ParsedRstDocstring.summary-def"><a name="L176"></a><tt class="py-lineno">176</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring.summary-toggle" onclick="return toggle('ParsedRstDocstring.summary');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#summary">summary</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedRstDocstring.summary-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ParsedRstDocstring.summary-expanded"><a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> <tt class="py-comment"># Inherit docs</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">visitor</tt> <tt class="py-op">=</tt> <tt id="link-38" class="py-name" targets="Class epydoc.markup.restructuredtext._SummaryExtractor=epydoc.markup.restructuredtext._SummaryExtractor-class.html"><a title="epydoc.markup.restructuredtext._SummaryExtractor" class="py-name" href="#" onclick="return doclink('link-38', '_SummaryExtractor', 'link-38');">_SummaryExtractor</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">)</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">.</tt><tt class="py-name">walk</tt><tt class="py-op">(</tt><tt class="py-name">visitor</tt><tt class="py-op">)</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">NodeFound</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">visitor</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name" targets="Variable epydoc.apidoc.APIDoc.summary=epydoc.apidoc.APIDoc-class.html#summary,Method epydoc.docwriter.html.HTMLWriter.summary()=epydoc.docwriter.html.HTMLWriter-class.html#summary,Method epydoc.markup.ConcatenatedDocstring.summary()=epydoc.markup.ConcatenatedDocstring-class.html#summary,Method epydoc.markup.ParsedDocstring.summary()=epydoc.markup.ParsedDocstring-class.html#summary,Method epydoc.markup.epytext.ParsedEpytextDocstring.summary()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#summary,Method epydoc.markup.javadoc.ParsedJavadocDocstring.summary()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#summary,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.summary()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary,Method epydoc.markup.restructuredtext.ParsedRstDocstring.summary()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#summary"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-39', 'summary', 'link-39');">summary</a></tt><tt class="py-op">,</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">visitor</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Variable epydoc.apidoc.APIDoc.other_docs=epydoc.apidoc.APIDoc-class.html#other_docs"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-40', 'other_docs', 'link-40');">other_docs</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"><tt class="py-comment"># def concatenate(self, other):</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># result = self._document.copy()</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># for child in (self._document.get_children() +</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># other._document.get_children()):</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># visitor = TreeCopyVisitor(self._document)</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># child.walkabout(visitor)</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># result.append(visitor.get_tree_copy())</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># return ParsedRstDocstring(result)</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="ParsedRstDocstring.to_html"></a><div id="ParsedRstDocstring.to_html-def"><a name="L192"></a><tt class="py-lineno">192</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring.to_html-toggle" onclick="return toggle('ParsedRstDocstring.to_html');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_html">to_html</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docstring_linker</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> <tt class="py-param">docindex</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedRstDocstring.to_html-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ParsedRstDocstring.to_html-expanded"><a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"> <tt class="py-comment"># Inherit docs</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">visitor</tt> <tt class="py-op">=</tt> <tt id="link-41" class="py-name" targets="Class epydoc.markup.restructuredtext._EpydocHTMLTranslator=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator" class="py-name" href="#" onclick="return doclink('link-41', '_EpydocHTMLTranslator', 'link-41');">_EpydocHTMLTranslator</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">,</tt> <tt class="py-name">docstring_linker</tt><tt class="py-op">,</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">.</tt><tt class="py-name">walkabout</tt><tt class="py-op">(</tt><tt class="py-name">visitor</tt><tt class="py-op">)</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">visitor</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name" targets="Method epydoc.markup.Field.body()=epydoc.markup.Field-class.html#body"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-42', 'body', 'link-42');">body</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"> </tt>
<a name="ParsedRstDocstring.to_latex"></a><div id="ParsedRstDocstring.to_latex-def"><a name="L200"></a><tt class="py-lineno">200</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring.to_latex-toggle" onclick="return toggle('ParsedRstDocstring.to_latex');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_latex">to_latex</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docstring_linker</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedRstDocstring.to_latex-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ParsedRstDocstring.to_latex-expanded"><a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> <tt class="py-comment"># Inherit docs</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">visitor</tt> <tt class="py-op">=</tt> <tt id="link-43" class="py-name" targets="Class epydoc.markup.restructuredtext._EpydocLaTeXTranslator=epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html"><a title="epydoc.markup.restructuredtext._EpydocLaTeXTranslator" class="py-name" href="#" onclick="return doclink('link-43', '_EpydocLaTeXTranslator', 'link-43');">_EpydocLaTeXTranslator</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">,</tt> <tt class="py-name">docstring_linker</tt><tt class="py-op">)</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">.</tt><tt class="py-name">walkabout</tt><tt class="py-op">(</tt><tt class="py-name">visitor</tt><tt class="py-op">)</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">visitor</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-44', 'body', 'link-42');">body</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> </tt>
<a name="ParsedRstDocstring.to_plaintext"></a><div id="ParsedRstDocstring.to_plaintext-def"><a name="L206"></a><tt class="py-lineno">206</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring.to_plaintext-toggle" onclick="return toggle('ParsedRstDocstring.to_plaintext');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_plaintext">to_plaintext</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docstring_linker</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedRstDocstring.to_plaintext-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ParsedRstDocstring.to_plaintext-expanded"><a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-comment"># This is should be replaced by something better:</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> </tt>
<a name="ParsedRstDocstring.__repr__"></a><div id="ParsedRstDocstring.__repr__-def"><a name="L210"></a><tt class="py-lineno">210</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring.__repr__-toggle" onclick="return toggle('ParsedRstDocstring.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'<ParsedRstDocstring: ...>'</tt> </tt>
</div><a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> </tt>
<a name="ParsedRstDocstring.index_terms"></a><div id="ParsedRstDocstring.index_terms-def"><a name="L212"></a><tt class="py-lineno">212</tt> <a class="py-toggle" href="#" id="ParsedRstDocstring.index_terms-toggle" onclick="return toggle('ParsedRstDocstring.index_terms');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#index_terms">index_terms</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedRstDocstring.index_terms-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ParsedRstDocstring.index_terms-expanded"><a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-name">visitor</tt> <tt class="py-op">=</tt> <tt id="link-45" class="py-name" targets="Class epydoc.markup.restructuredtext._TermsExtractor=epydoc.markup.restructuredtext._TermsExtractor-class.html"><a title="epydoc.markup.restructuredtext._TermsExtractor" class="py-name" href="#" onclick="return doclink('link-45', '_TermsExtractor', 'link-45');">_TermsExtractor</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">)</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_document</tt><tt class="py-op">.</tt><tt class="py-name">walkabout</tt><tt class="py-op">(</tt><tt class="py-name">visitor</tt><tt class="py-op">)</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">visitor</tt><tt class="py-op">.</tt><tt class="py-name">terms</tt> </tt>
</div></div><a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> </tt>
<a name="_EpydocReader"></a><div id="_EpydocReader-def"><a name="L217"></a><tt class="py-lineno">217</tt> <a class="py-toggle" href="#" id="_EpydocReader-toggle" onclick="return toggle('_EpydocReader');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocReader-class.html">_EpydocReader</a><tt class="py-op">(</tt><tt class="py-base-class">ApiLinkReader</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocReader-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_EpydocReader-expanded"><a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"><tt class="py-docstring"> A reader that captures all errors that are generated by parsing,</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"><tt class="py-docstring"> and appends them to a list.</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-comment"># Remove the DocInfo transform, to ensure that :author: fields are</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># correctly handled. This needs to be handled differently</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># depending on the version of docutils that's being used, because</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the default_transforms attribute was deprecated & replaced by</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># get_transforms().</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">version</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">int</tt><tt class="py-op">(</tt><tt id="link-46" class="py-name" targets="Variable epydoc.markup.restructuredtext._EpydocReader.v=epydoc.markup.restructuredtext._EpydocReader-class.html#v"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-46', 'v', 'link-46');">v</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-47" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-47', 'v', 'link-46');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name" targets="Variable epydoc.__version__=epydoc-module.html#__version__"><a title="epydoc.__version__" class="py-name" href="#" onclick="return doclink('link-48', '__version__', 'link-48');">__version__</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'.'</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> <tt class="py-name">version</tt> <tt class="py-op">+=</tt> <tt class="py-op">[</tt> <tt class="py-number">0</tt> <tt class="py-op">]</tt> <tt class="py-op">*</tt> <tt class="py-op">(</tt><tt class="py-number">3</tt> <tt class="py-op">-</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">version</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">version</tt> <tt class="py-op"><</tt> <tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">,</tt><tt class="py-number">4</tt><tt class="py-op">,</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"> <tt id="link-49" class="py-name" targets="Variable epydoc.markup.restructuredtext._EpydocReader.default_transforms=epydoc.markup.restructuredtext._EpydocReader-class.html#default_transforms"><a title="epydoc.markup.restructuredtext._EpydocReader.default_transforms" class="py-name" href="#" onclick="return doclink('link-49', 'default_transforms', 'link-49');">default_transforms</a></tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt id="link-50" class="py-name"><a title="epydoc.docwriter.xlink.ApiLinkReader" class="py-name" href="#" onclick="return doclink('link-50', 'ApiLinkReader', 'link-17');">ApiLinkReader</a></tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.default_transforms" class="py-name" href="#" onclick="return doclink('link-51', 'default_transforms', 'link-49');">default_transforms</a></tt><tt class="py-op">)</tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-52" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.default_transforms" class="py-name" href="#" onclick="return doclink('link-52', 'default_transforms', 'link-49');">default_transforms</a></tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">transforms</tt><tt class="py-op">.</tt><tt class="py-name">frontmatter</tt><tt class="py-op">.</tt><tt class="py-name">DocInfo</tt><tt class="py-op">)</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="_EpydocReader.get_transforms"></a><div id="_EpydocReader.get_transforms-def"><a name="L234"></a><tt class="py-lineno">234</tt> <a class="py-toggle" href="#" id="_EpydocReader.get_transforms-toggle" onclick="return toggle('_EpydocReader.get_transforms');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocReader-class.html#get_transforms">get_transforms</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocReader.get_transforms-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="_EpydocReader.get_transforms-expanded"><a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">t</tt> <tt class="py-keyword">for</tt> <tt class="py-name">t</tt> <tt class="py-keyword">in</tt> <tt id="link-53" class="py-name"><a title="epydoc.docwriter.xlink.ApiLinkReader" class="py-name" href="#" onclick="return doclink('link-53', 'ApiLinkReader', 'link-17');">ApiLinkReader</a></tt><tt class="py-op">.</tt><tt id="link-54" class="py-name" targets="Method epydoc.markup.restructuredtext._EpydocReader.get_transforms()=epydoc.markup.restructuredtext._EpydocReader-class.html#get_transforms"><a title="epydoc.markup.restructuredtext._EpydocReader.get_transforms" class="py-name" href="#" onclick="return doclink('link-54', 'get_transforms', 'link-54');">get_transforms</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">t</tt> <tt class="py-op">!=</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">transforms</tt><tt class="py-op">.</tt><tt class="py-name">frontmatter</tt><tt class="py-op">.</tt><tt class="py-name">DocInfo</tt><tt class="py-op">]</tt> </tt>
</div><a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">version</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"> </tt>
<a name="_EpydocReader.__init__"></a><div id="_EpydocReader.__init__-def"><a name="L239"></a><tt class="py-lineno">239</tt> <a class="py-toggle" href="#" id="_EpydocReader.__init__-toggle" onclick="return toggle('_EpydocReader.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocReader-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocReader.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocReader.__init__-expanded"><a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_errors</tt> <tt class="py-op">=</tt> <tt class="py-name">errors</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"> <tt id="link-55" class="py-name"><a title="epydoc.docwriter.xlink.ApiLinkReader" class="py-name" href="#" onclick="return doclink('link-55', 'ApiLinkReader', 'link-17');">ApiLinkReader</a></tt><tt class="py-op">.</tt><tt id="link-56" class="py-name" targets="Method epydoc.apidoc.APIDoc.__init__()=epydoc.apidoc.APIDoc-class.html#__init__,Method epydoc.apidoc.DocIndex.__init__()=epydoc.apidoc.DocIndex-class.html#__init__,Method epydoc.apidoc.DottedName.__init__()=epydoc.apidoc.DottedName-class.html#__init__,Method epydoc.apidoc.NamespaceDoc.__init__()=epydoc.apidoc.NamespaceDoc-class.html#__init__,Method epydoc.apidoc.VariableDoc.__init__()=epydoc.apidoc.VariableDoc-class.html#__init__,Method epydoc.apidoc._Sentinel.__init__()=epydoc.apidoc._Sentinel-class.html#__init__,Method epydoc.checker.DocChecker.__init__()=epydoc.checker.DocChecker-class.html#__init__,Method epydoc.cli.ConsoleLogger.__init__()=epydoc.cli.ConsoleLogger-class.html#__init__,Method epydoc.cli.HTMLLogger.__init__()=epydoc.cli.HTMLLogger-class.html#__init__,Method epydoc.cli.TerminalController.__init__()=epydoc.cli.TerminalController-class.html#__init__,Method epydoc.cli.UnifiedProgressConsoleLogger.__init__()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#__init__,Method epydoc.docbuilder.BuildOptions.__init__()=epydoc.docbuilder.BuildOptions-class.html#__init__,Method epydoc.docbuilder._ProgressEstimator.__init__()=epydoc.docbuilder._ProgressEstimator-class.html#__init__,Method epydoc.docintrospecter._DevNull.__init__()=epydoc.docintrospecter._DevNull-class.html#__init__,Method epydoc.docstringparser.DocstringField.__init__()=epydoc.docstringparser.DocstringField-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraph.__init__()=epydoc.docwriter.dotgraph.DotGraph-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphEdge.__init__()=epydoc.docwriter.dotgraph.DotGraphEdge-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphNode.__init__()=epydoc.docwriter.dotgraph.DotGraphNode-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__()=epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__()=epydoc.docwriter.dotgraph.DotGraphUmlModuleNode-class.html#__init__,Method epydoc.docwriter.html.HTMLWriter.__init__()=epydoc.docwriter.html.HTMLWriter-class.html#__init__,Method epydoc.docwriter.html._HTMLDocstringLinker.__init__()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__,Method epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__()=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#__init__,Method epydoc.docwriter.latex.LatexWriter.__init__()=epydoc.docwriter.latex.LatexWriter-class.html#__init__,Method epydoc.docwriter.xlink.ApiLinkReader.__init__()=epydoc.docwriter.xlink.ApiLinkReader-class.html#__init__,Method epydoc.docwriter.xlink.DocUrlGenerator.__init__()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#__init__,Method epydoc.gui.EpydocGUI.__init__()=epydoc.gui.EpydocGUI-class.html#__init__,Method epydoc.gui.GUILogger.__init__()=epydoc.gui.GUILogger-class.html#__init__,Method epydoc.log.SimpleLogger.__init__()=epydoc.log.SimpleLogger-class.html#__init__,Method epydoc.markup.ConcatenatedDocstring.__init__()=epydoc.markup.ConcatenatedDocstring-class.html#__init__,Method epydoc.markup.Field.__init__()=epydoc.markup.Field-class.html#__init__,Method epydoc.markup.ParseError.__init__()=epydoc.markup.ParseError-class.html#__init__,Method epydoc.markup.epytext.ColorizingError.__init__()=epydoc.markup.epytext.ColorizingError-class.html#__init__,Method epydoc.markup.epytext.Element.__init__()=epydoc.markup.epytext.Element-class.html#__init__,Method epydoc.markup.epytext.ParsedEpytextDocstring.__init__()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__init__,Method epydoc.markup.epytext.Token.__init__()=epydoc.markup.epytext.Token-class.html#__init__,Method epydoc.markup.javadoc.ParsedJavadocDocstring.__init__()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#__init__,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__,Method epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__()=epydoc.markup.pyval_repr.ColorizedPyvalRepr-class.html#__init__,Method epydoc.markup.pyval_repr.PyvalColorizer.__init__()=epydoc.markup.pyval_repr.PyvalColorizer-class.html#__init__,Method epydoc.markup.pyval_repr._ColorizerState.__init__()=epydoc.markup.pyval_repr._ColorizerState-class.html#__init__,Method epydoc.markup.restructuredtext.ParsedRstDocstring.__init__()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#__init__,Method epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__()=epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__()=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__()=epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocReader.__init__()=epydoc.markup.restructuredtext._EpydocReader-class.html#__init__,Method epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__()=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._SummaryExtractor.__init__()=epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__,Method epydoc.markup.restructuredtext._TermsExtractor.__init__()=epydoc.markup.restructuredtext._TermsExtractor-class.html#__init__,Method epydoc.markup.restructuredtext.dotgraph.__init__()=epydoc.markup.restructuredtext.dotgraph-class.html#__init__,Method epydoc.util.RunSubprocessError.__init__()=epydoc.util.RunSubprocessError-class.html#__init__"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-56', '__init__', 'link-56');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div><a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"> </tt>
<a name="_EpydocReader.new_document"></a><div id="_EpydocReader.new_document-def"><a name="L243"></a><tt class="py-lineno">243</tt> <a class="py-toggle" href="#" id="_EpydocReader.new_document-toggle" onclick="return toggle('_EpydocReader.new_document');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocReader-class.html#new_document">new_document</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocReader.new_document-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocReader.new_document-expanded"><a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"> <tt id="link-57" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-57', 'document', 'link-30');">document</a></tt> <tt class="py-op">=</tt> <tt id="link-58" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.new_document" class="py-name" href="#" onclick="return doclink('link-58', 'new_document', 'link-2');">new_document</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">source</tt><tt class="py-op">.</tt><tt class="py-name">source_path</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name" targets="Variable epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#settings,Variable epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings=epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#settings"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-59', 'settings', 'link-59');">settings</a></tt><tt class="py-op">)</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"> <tt class="py-comment"># Capture all warning messages.</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-60" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-60', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">reporter</tt><tt class="py-op">.</tt><tt class="py-name">attach_observer</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name" targets="Method epydoc.markup.restructuredtext._EpydocReader.report()=epydoc.markup.restructuredtext._EpydocReader-class.html#report"><a title="epydoc.markup.restructuredtext._EpydocReader.report" class="py-name" href="#" onclick="return doclink('link-61', 'report', 'link-61');">report</a></tt><tt class="py-op">)</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"> <tt class="py-comment"># These are used so we know how to encode warning messages:</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_encoding</tt> <tt class="py-op">=</tt> <tt id="link-62" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-62', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">reporter</tt><tt class="py-op">.</tt><tt class="py-name">encoding</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_error_handler</tt> <tt class="py-op">=</tt> <tt id="link-63" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-63', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">reporter</tt><tt class="py-op">.</tt><tt class="py-name">error_handler</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-comment"># Return the new document.</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-64" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-64', 'document', 'link-30');">document</a></tt> </tt>
</div><a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> </tt>
<a name="_EpydocReader.report"></a><div id="_EpydocReader.report-def"><a name="L253"></a><tt class="py-lineno">253</tt> <a class="py-toggle" href="#" id="_EpydocReader.report-toggle" onclick="return toggle('_EpydocReader.report');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocReader-class.html#report">report</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocReader.report-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocReader.report-expanded"><a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-65" class="py-name" targets="Method epydoc.markup.ParseError.is_fatal()=epydoc.markup.ParseError-class.html#is_fatal"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-65', 'is_fatal', 'link-65');">is_fatal</a></tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt id="link-66" class="py-name" targets="Function epydoc.log.error()=epydoc.log-module.html#error"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-66', 'error', 'link-66');">error</a></tt><tt class="py-op">[</tt><tt class="py-string">'level'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">2</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt id="link-67" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-67', 'is_fatal', 'link-65');">is_fatal</a></tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-68" class="py-name" targets="Method epydoc.markup.ParseError.linenum()=epydoc.markup.ParseError-class.html#linenum"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-68', 'linenum', 'link-68');">linenum</a></tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt id="link-69" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-69', 'error', 'link-66');">error</a></tt><tt class="py-op">[</tt><tt class="py-string">'line'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt id="link-70" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-70', 'linenum', 'link-68');">linenum</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">c</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_encoding</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_error_handler</tt><tt class="py-op">)</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt id="link-71" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-71', 'error', 'link-66');">error</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-72" class="py-name" targets="Class epydoc.docparser.ParseError=epydoc.docparser.ParseError-class.html,Class epydoc.markup.ParseError=epydoc.markup.ParseError-class.html"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-72', 'ParseError', 'link-72');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">,</tt> <tt id="link-73" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-73', 'linenum', 'link-68');">linenum</a></tt><tt class="py-op">,</tt> <tt id="link-74" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-74', 'is_fatal', 'link-65');">is_fatal</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> </tt>
<a name="_DocumentPseudoWriter"></a><div id="_DocumentPseudoWriter-def"><a name="L264"></a><tt class="py-lineno">264</tt> <a class="py-toggle" href="#" id="_DocumentPseudoWriter-toggle" onclick="return toggle('_DocumentPseudoWriter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html">_DocumentPseudoWriter</a><tt class="py-op">(</tt><tt class="py-base-class">Writer</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_DocumentPseudoWriter-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_DocumentPseudoWriter-expanded"><a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"><tt class="py-docstring"> A pseudo-writer for the docutils framework, that can be used to</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"><tt class="py-docstring"> access the document itself. The output of C{_DocumentPseudoWriter}</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"><tt class="py-docstring"> is just an empty string; but after it has been used, the most</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"><tt class="py-docstring"> recently processed document is available as the instance variable</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"><tt class="py-docstring"> C{document}</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"><tt class="py-docstring"> @type document: C{docutils.nodes.document}</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-docstring"> @ivar document: The most recently processed document.</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="_DocumentPseudoWriter.__init__"></a><div id="_DocumentPseudoWriter.__init__-def"><a name="L275"></a><tt class="py-lineno">275</tt> <a class="py-toggle" href="#" id="_DocumentPseudoWriter.__init__-toggle" onclick="return toggle('_DocumentPseudoWriter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_DocumentPseudoWriter.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_DocumentPseudoWriter.__init__-expanded"><a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-75', 'document', 'link-30');">document</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-name">Writer</tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-76', '__init__', 'link-56');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div><a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"> </tt>
<a name="_DocumentPseudoWriter.translate"></a><div id="_DocumentPseudoWriter.translate-def"><a name="L279"></a><tt class="py-lineno">279</tt> <a class="py-toggle" href="#" id="_DocumentPseudoWriter.translate-toggle" onclick="return toggle('_DocumentPseudoWriter.translate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html#translate">translate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_DocumentPseudoWriter.translate-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_DocumentPseudoWriter.translate-expanded"><a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
</div></div><a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> </tt>
<a name="_SummaryExtractor"></a><div id="_SummaryExtractor-def"><a name="L282"></a><tt class="py-lineno">282</tt> <a class="py-toggle" href="#" id="_SummaryExtractor-toggle" onclick="return toggle('_SummaryExtractor');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html">_SummaryExtractor</a><tt class="py-op">(</tt><tt class="py-base-class">NodeVisitor</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SummaryExtractor-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_SummaryExtractor-expanded"><a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"><tt class="py-docstring"> A docutils node visitor that extracts the first sentence from</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"><tt class="py-docstring"> the first paragraph in a document.</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="_SummaryExtractor.__init__"></a><div id="_SummaryExtractor.__init__-def"><a name="L287"></a><tt class="py-lineno">287</tt> <a class="py-toggle" href="#" id="_SummaryExtractor.__init__-toggle" onclick="return toggle('_SummaryExtractor.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">document</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SummaryExtractor.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SummaryExtractor.__init__-expanded"><a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-name">NodeVisitor</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-77', '__init__', 'link-56');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-78" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-78', 'document', 'link-30');">document</a></tt><tt class="py-op">)</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-79', 'summary', 'link-39');">summary</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-80', 'other_docs', 'link-40');">other_docs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> </tt>
<a name="_SummaryExtractor.visit_document"></a><div id="_SummaryExtractor.visit_document-def"><a name="L292"></a><tt class="py-lineno">292</tt> <a class="py-toggle" href="#" id="_SummaryExtractor.visit_document-toggle" onclick="return toggle('_SummaryExtractor.visit_document');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#visit_document">visit_document</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SummaryExtractor.visit_document-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SummaryExtractor.visit_document-expanded"><a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-81', 'summary', 'link-39');">summary</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt id="link-82" class="py-name" targets="Variable epydoc.markup.epytext.ParsedEpytextDocstring._SUMMARY_RE=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_SUMMARY_RE,Variable epydoc.markup.javadoc.ParsedJavadocDocstring._SUMMARY_RE=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#_SUMMARY_RE,Variable epydoc.markup.plaintext.ParsedPlaintextDocstring._SUMMARY_RE=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#_SUMMARY_RE,Variable epydoc.markup.restructuredtext._SummaryExtractor._SUMMARY_RE=epydoc.markup.restructuredtext._SummaryExtractor-class.html#_SUMMARY_RE"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._SUMMARY_RE
epydoc.markup.javadoc.ParsedJavadocDocstring._SUMMARY_RE
epydoc.markup.plaintext.ParsedPlaintextDocstring._SUMMARY_RE
epydoc.markup.restructuredtext._SummaryExtractor._SUMMARY_RE" class="py-name" href="#" onclick="return doclink('link-82', '_SUMMARY_RE', 'link-82');">_SUMMARY_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'(\s*[\w\W]*?\.)(\s|$)'</tt><tt class="py-op">)</tt> </tt>
<a name="_SummaryExtractor.visit_paragraph"></a><div id="_SummaryExtractor.visit_paragraph-def"><a name="L296"></a><tt class="py-lineno">296</tt> <a class="py-toggle" href="#" id="_SummaryExtractor.visit_paragraph-toggle" onclick="return toggle('_SummaryExtractor.visit_paragraph');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#visit_paragraph">visit_paragraph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SummaryExtractor.visit_paragraph-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SummaryExtractor.visit_paragraph-expanded"><a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-83', 'summary', 'link-39');">summary</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> <tt class="py-comment"># found a paragraph after the first one</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-84', 'other_docs', 'link-40');">other_docs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">NodeFound</tt><tt class="py-op">(</tt><tt class="py-string">'Found summary'</tt><tt class="py-op">)</tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-name">summary_pieces</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> <tt class="py-comment"># Extract the first sentence.</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">child</tt> <tt class="py-keyword">in</tt> <tt class="py-name">node</tt><tt class="py-op">:</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">,</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">Text</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._SUMMARY_RE
epydoc.markup.javadoc.ParsedJavadocDocstring._SUMMARY_RE
epydoc.markup.plaintext.ParsedPlaintextDocstring._SUMMARY_RE
epydoc.markup.restructuredtext._SummaryExtractor._SUMMARY_RE" class="py-name" href="#" onclick="return doclink('link-85', '_SUMMARY_RE', 'link-82');">_SUMMARY_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">)</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">m</tt><tt class="py-op">:</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"> <tt class="py-name">summary_pieces</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">Text</tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"> <tt class="py-name">other</tt> <tt class="py-op">=</tt> <tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">end</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">other</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">isspace</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-86" class="py-name"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-86', 'other_docs', 'link-40');">other_docs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"> <tt class="py-name">summary_pieces</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">)</tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"> <tt class="py-name">summary_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-87" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-87', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-comment"># shallow copy</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"> <tt class="py-name">summary_para</tt> <tt class="py-op">=</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-comment"># shallow copy</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"> <tt class="py-name">summary_doc</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">summary_para</tt><tt class="py-op">]</tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"> <tt class="py-name">summary_para</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">summary_pieces</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-88', 'summary', 'link-39');">summary</a></tt> <tt class="py-op">=</tt> <tt id="link-89" class="py-name"><a title="epydoc.markup.restructuredtext.ParsedRstDocstring" class="py-name" href="#" onclick="return doclink('link-89', 'ParsedRstDocstring', 'link-29');">ParsedRstDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">summary_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"> </tt>
<a name="_SummaryExtractor.visit_field"></a><div id="_SummaryExtractor.visit_field-def"><a name="L322"></a><tt class="py-lineno">322</tt> <a class="py-toggle" href="#" id="_SummaryExtractor.visit_field-toggle" onclick="return toggle('_SummaryExtractor.visit_field');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#visit_field">visit_field</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SummaryExtractor.visit_field-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SummaryExtractor.visit_field-expanded"><a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">SkipNode</tt> </tt>
</div><a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"> </tt>
<a name="_SummaryExtractor.unknown_visit"></a><div id="_SummaryExtractor.unknown_visit-def"><a name="L325"></a><tt class="py-lineno">325</tt> <a class="py-toggle" href="#" id="_SummaryExtractor.unknown_visit-toggle" onclick="return toggle('_SummaryExtractor.unknown_visit');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SummaryExtractor-class.html#unknown_visit">unknown_visit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SummaryExtractor.unknown_visit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SummaryExtractor.unknown_visit-expanded"><a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"> <tt class="py-docstring">'Ignore all unknown nodes'</tt> </tt>
</div></div><a name="L327"></a><tt class="py-lineno">327</tt> <tt class="py-line"> </tt>
<a name="_TermsExtractor"></a><div id="_TermsExtractor-def"><a name="L328"></a><tt class="py-lineno">328</tt> <a class="py-toggle" href="#" id="_TermsExtractor-toggle" onclick="return toggle('_TermsExtractor');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._TermsExtractor-class.html">_TermsExtractor</a><tt class="py-op">(</tt><tt class="py-base-class">NodeVisitor</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_TermsExtractor-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_TermsExtractor-expanded"><a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"><tt class="py-docstring"> A docutils node visitor that extracts the terms from documentation.</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"><tt class="py-docstring"> Terms are created using the C{:term:} interpreted text role.</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="_TermsExtractor.__init__"></a><div id="_TermsExtractor.__init__-def"><a name="L334"></a><tt class="py-lineno">334</tt> <a class="py-toggle" href="#" id="_TermsExtractor.__init__-toggle" onclick="return toggle('_TermsExtractor.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._TermsExtractor-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">document</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_TermsExtractor.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_TermsExtractor.__init__-expanded"><a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"> <tt class="py-name">NodeVisitor</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-90', '__init__', 'link-56');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-91" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-91', 'document', 'link-30');">document</a></tt><tt class="py-op">)</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">terms</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"><tt class="py-string"> The terms currently found.</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"><tt class="py-string"> @type: C{list}</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
</div><a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"> </tt>
<a name="_TermsExtractor.visit_document"></a><div id="_TermsExtractor.visit_document-def"><a name="L343"></a><tt class="py-lineno">343</tt> <a class="py-toggle" href="#" id="_TermsExtractor.visit_document-toggle" onclick="return toggle('_TermsExtractor.visit_document');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._TermsExtractor-class.html#visit_document">visit_document</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_TermsExtractor.visit_document-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_TermsExtractor.visit_document-expanded"><a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">terms</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_term</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"> </tt>
<a name="_TermsExtractor.visit_emphasis"></a><div id="_TermsExtractor.visit_emphasis-def"><a name="L347"></a><tt class="py-lineno">347</tt> <a class="py-toggle" href="#" id="_TermsExtractor.visit_emphasis-toggle" onclick="return toggle('_TermsExtractor.visit_emphasis');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._TermsExtractor-class.html#visit_emphasis">visit_emphasis</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_TermsExtractor.visit_emphasis-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_TermsExtractor.visit_emphasis-expanded"><a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'term'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'classes'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_term</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"> </tt>
<a name="_TermsExtractor.depart_emphasis"></a><div id="_TermsExtractor.depart_emphasis-def"><a name="L351"></a><tt class="py-lineno">351</tt> <a class="py-toggle" href="#" id="_TermsExtractor.depart_emphasis-toggle" onclick="return toggle('_TermsExtractor.depart_emphasis');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._TermsExtractor-class.html#depart_emphasis">depart_emphasis</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_TermsExtractor.depart_emphasis-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_TermsExtractor.depart_emphasis-expanded"><a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'term'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'classes'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_term</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"> </tt>
<a name="_TermsExtractor.visit_Text"></a><div id="_TermsExtractor.visit_Text-def"><a name="L355"></a><tt class="py-lineno">355</tt> <a class="py-toggle" href="#" id="_TermsExtractor.visit_Text-toggle" onclick="return toggle('_TermsExtractor.visit_Text');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._TermsExtractor-class.html#visit_Text">visit_Text</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_TermsExtractor.visit_Text-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_TermsExtractor.visit_Text-expanded"><a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_term</tt><tt class="py-op">:</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-92', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">terms</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-93" class="py-name"><a title="epydoc.markup.restructuredtext.ParsedRstDocstring" class="py-name" href="#" onclick="return doclink('link-93', 'ParsedRstDocstring', 'link-29');">ParsedRstDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> </tt>
<a name="_TermsExtractor.unknown_visit"></a><div id="_TermsExtractor.unknown_visit-def"><a name="L361"></a><tt class="py-lineno">361</tt> <a class="py-toggle" href="#" id="_TermsExtractor.unknown_visit-toggle" onclick="return toggle('_TermsExtractor.unknown_visit');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._TermsExtractor-class.html#unknown_visit">unknown_visit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_TermsExtractor.unknown_visit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_TermsExtractor.unknown_visit-expanded"><a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> <tt class="py-docstring">'Ignore all unknown nodes'</tt> </tt>
</div><a name="L363"></a><tt class="py-lineno">363</tt> <tt class="py-line"> </tt>
<a name="_TermsExtractor.unknown_departure"></a><div id="_TermsExtractor.unknown_departure-def"><a name="L364"></a><tt class="py-lineno">364</tt> <a class="py-toggle" href="#" id="_TermsExtractor.unknown_departure-toggle" onclick="return toggle('_TermsExtractor.unknown_departure');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._TermsExtractor-class.html#unknown_departure">unknown_departure</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_TermsExtractor.unknown_departure-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_TermsExtractor.unknown_departure-expanded"><a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"> <tt class="py-docstring">'Ignore all unknown nodes'</tt> </tt>
</div></div><a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator"></a><div id="_SplitFieldsTranslator-def"><a name="L367"></a><tt class="py-lineno">367</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator-toggle" onclick="return toggle('_SplitFieldsTranslator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html">_SplitFieldsTranslator</a><tt class="py-op">(</tt><tt class="py-base-class">NodeVisitor</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_SplitFieldsTranslator-expanded"><a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L369"></a><tt class="py-lineno">369</tt> <tt class="py-line"><tt class="py-docstring"> A docutils translator that removes all fields from a document, and</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"><tt class="py-docstring"> collects them into the instance variable C{fields}</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"><tt class="py-docstring"> @ivar fields: The fields of the most recently walked document.</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"><tt class="py-docstring"> @type fields: C{list} of L{Field<markup.Field>}</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"> <tt id="link-94" class="py-name" targets="Variable epydoc.markup.restructuredtext._SplitFieldsTranslator.ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator.ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD" class="py-name" href="#" onclick="return doclink('link-94', 'ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD', 'link-94');">ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt> <tt class="py-line"> <tt class="py-string">"""If true, then consolidated fields are not required to mark</tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"><tt class="py-string"> arguments with C{`backticks`}. (This is currently only</tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"><tt class="py-string"> implemented for consolidated fields expressed as definition lists;</tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"><tt class="py-string"> consolidated fields expressed as unordered lists still require</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"><tt class="py-string"> backticks for now."""</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator.__init__"></a><div id="_SplitFieldsTranslator.__init__-def"><a name="L383"></a><tt class="py-lineno">383</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator.__init__-toggle" onclick="return toggle('_SplitFieldsTranslator.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">document</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator.__init__-expanded"><a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"> <tt class="py-name">NodeVisitor</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-95', '__init__', 'link-56');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-96" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-96', 'document', 'link-30');">document</a></tt><tt class="py-op">)</tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_errors</tt> <tt class="py-op">=</tt> <tt class="py-name">errors</tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_newfields</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
</div><a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator.visit_document"></a><div id="_SplitFieldsTranslator.visit_document-def"><a name="L389"></a><tt class="py-lineno">389</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator.visit_document-toggle" onclick="return toggle('_SplitFieldsTranslator.visit_document');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#visit_document">visit_document</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator.visit_document-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator.visit_document-expanded"><a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator.visit_field"></a><div id="_SplitFieldsTranslator.visit_field-def"><a name="L392"></a><tt class="py-lineno">392</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator.visit_field-toggle" onclick="return toggle('_SplitFieldsTranslator.visit_field');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#visit_field">visit_field</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator.visit_field-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator.visit_field-expanded"><a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"> <tt class="py-comment"># Remove the field from the tree.</tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">parent</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">)</tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"> <tt class="py-comment"># Extract the field name & optional argument</tt> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-97" class="py-name" targets="Method epydoc.markup.Field.tag()=epydoc.markup.Field-class.html#tag"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-97', 'tag', 'link-97');">tag</a></tt> <tt class="py-op">=</tt> <tt class="py-name">node</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"> <tt class="py-name">tagname</tt> <tt class="py-op">=</tt> <tt id="link-98" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-98', 'tag', 'link-97');">tag</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-99" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-99', 'tag', 'link-97');">tag</a></tt><tt class="py-op">)</tt><tt class="py-op">></tt><tt class="py-number">1</tt><tt class="py-op">:</tt> <tt id="link-100" class="py-name" targets="Method epydoc.markup.Field.arg()=epydoc.markup.Field-class.html#arg"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-100', 'arg', 'link-100');">arg</a></tt> <tt class="py-op">=</tt> <tt id="link-101" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-101', 'tag', 'link-97');">tag</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt id="link-102" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-102', 'arg', 'link-100');">arg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt> <tt class="py-line"> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"> <tt class="py-comment"># Handle special fields:</tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">fbody</tt> <tt class="py-op">=</tt> <tt class="py-name">node</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-103" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-103', 'arg', 'link-100');">arg</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L405"></a><tt class="py-lineno">405</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">list_tag</tt><tt class="py-op">,</tt> <tt class="py-name">entry_tag</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-104" class="py-name"><a title="epydoc.markup.restructuredtext.CONSOLIDATED_FIELDS" class="py-name" href="#" onclick="return doclink('link-104', 'CONSOLIDATED_FIELDS', 'link-24');">CONSOLIDATED_FIELDS</a></tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tagname</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">list_tag</tt><tt class="py-op">:</tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L408"></a><tt class="py-lineno">408</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name" targets="Method epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_field()=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#handle_consolidated_field"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_field" class="py-name" href="#" onclick="return doclink('link-105', 'handle_consolidated_field', 'link-105');">handle_consolidated_field</a></tt><tt class="py-op">(</tt><tt class="py-name">fbody</tt><tt class="py-op">,</tt> <tt class="py-name">entry_tag</tt><tt class="py-op">)</tt> </tt>
<a name="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">'Unable to split consolidated field '</tt> </tt>
<a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">+=</tt> <tt class="py-string">'"%s" - %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">tagname</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L413"></a><tt class="py-lineno">413</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-106" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-106', 'ParseError', 'link-72');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> </tt>
<a name="L414"></a><tt class="py-lineno">414</tt> <tt class="py-line"> <tt id="link-107" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-107', 'is_fatal', 'link-65');">is_fatal</a></tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt> <tt class="py-line"> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"> <tt class="py-comment"># Use a @newfield to let it be displayed as-is.</tt> </tt>
<a name="L417"></a><tt class="py-lineno">417</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">tagname</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_newfields</tt><tt class="py-op">:</tt> </tt>
<a name="L418"></a><tt class="py-lineno">418</tt> <tt class="py-line"> <tt class="py-name">newfield</tt> <tt class="py-op">=</tt> <tt id="link-108" class="py-name" targets="Class epydoc.markup.Field=epydoc.markup.Field-class.html"><a title="epydoc.markup.Field" class="py-name" href="#" onclick="return doclink('link-108', 'Field', 'link-108');">Field</a></tt><tt class="py-op">(</tt><tt class="py-string">'newfield'</tt><tt class="py-op">,</tt> <tt class="py-name">tagname</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"> <tt id="link-109" class="py-name" targets="Function epydoc.markup.epytext.parse()=epydoc.markup.epytext-module.html#parse,Function epydoc.markup.parse()=epydoc.markup-module.html#parse"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-109', 'parse', 'link-109');">parse</a></tt><tt class="py-op">(</tt><tt class="py-name">tagname</tt><tt class="py-op">,</tt> <tt class="py-string">'plaintext'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">newfield</tt><tt class="py-op">)</tt> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_newfields</tt><tt class="py-op">[</tt><tt class="py-name">tagname</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-110" class="py-name" targets="Method epydoc.markup.restructuredtext._SplitFieldsTranslator._add_field()=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#_add_field"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator._add_field" class="py-name" href="#" onclick="return doclink('link-110', '_add_field', 'link-110');">_add_field</a></tt><tt class="py-op">(</tt><tt class="py-name">tagname</tt><tt class="py-op">,</tt> <tt id="link-111" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-111', 'arg', 'link-100');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">fbody</tt><tt class="py-op">)</tt> </tt>
</div><a name="L424"></a><tt class="py-lineno">424</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator._add_field"></a><div id="_SplitFieldsTranslator._add_field-def"><a name="L425"></a><tt class="py-lineno">425</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator._add_field-toggle" onclick="return toggle('_SplitFieldsTranslator._add_field');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#_add_field">_add_field</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">tagname</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">fbody</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator._add_field-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator._add_field-expanded"><a name="L426"></a><tt class="py-lineno">426</tt> <tt class="py-line"> <tt class="py-name">field_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-112" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-112', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">child</tt> <tt class="py-keyword">in</tt> <tt class="py-name">fbody</tt><tt class="py-op">:</tt> <tt class="py-name">field_doc</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">)</tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"> <tt class="py-name">field_pdoc</tt> <tt class="py-op">=</tt> <tt id="link-113" class="py-name"><a title="epydoc.markup.restructuredtext.ParsedRstDocstring" class="py-name" href="#" onclick="return doclink('link-113', 'ParsedRstDocstring', 'link-29');">ParsedRstDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">field_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-114" class="py-name"><a title="epydoc.markup.Field" class="py-name" href="#" onclick="return doclink('link-114', 'Field', 'link-108');">Field</a></tt><tt class="py-op">(</tt><tt class="py-name">tagname</tt><tt class="py-op">,</tt> <tt id="link-115" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-115', 'arg', 'link-100');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">field_pdoc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator.visit_field_list"></a><div id="_SplitFieldsTranslator.visit_field_list-def"><a name="L431"></a><tt class="py-lineno">431</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator.visit_field_list-toggle" onclick="return toggle('_SplitFieldsTranslator.visit_field_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#visit_field_list">visit_field_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator.visit_field_list-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator.visit_field_list-expanded"><a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"> <tt class="py-comment"># Remove the field list from the tree. The visitor will still walk</tt> </tt>
<a name="L433"></a><tt class="py-lineno">433</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># over the node's children.</tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">parent</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">)</tt> </tt>
</div><a name="L435"></a><tt class="py-lineno">435</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator.handle_consolidated_field"></a><div id="_SplitFieldsTranslator.handle_consolidated_field-def"><a name="L436"></a><tt class="py-lineno">436</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator.handle_consolidated_field-toggle" onclick="return toggle('_SplitFieldsTranslator.handle_consolidated_field');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#handle_consolidated_field">handle_consolidated_field</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">,</tt> <tt class="py-param">tagname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator.handle_consolidated_field-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator.handle_consolidated_field-expanded"><a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt> <tt class="py-line"><tt class="py-docstring"> Attempt to handle a consolidated section.</tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L440"></a><tt class="py-lineno">440</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-116" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-116', 'body', 'link-42');">body</a></tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'does not contain a single list.'</tt><tt class="py-op">)</tt> </tt>
<a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-117" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-117', 'body', 'link-42');">body</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">==</tt> <tt class="py-string">'bullet_list'</tt><tt class="py-op">:</tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-118" class="py-name" targets="Method epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_bullet_list()=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#handle_consolidated_bullet_list"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_bullet_list" class="py-name" href="#" onclick="return doclink('link-118', 'handle_consolidated_bullet_list', 'link-118');">handle_consolidated_bullet_list</a></tt><tt class="py-op">(</tt><tt id="link-119" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-119', 'body', 'link-42');">body</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">tagname</tt><tt class="py-op">)</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt id="link-120" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-120', 'body', 'link-42');">body</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">==</tt> <tt class="py-string">'definition_list'</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt> <tt class="py-line"> <tt class="py-name">tagname</tt> <tt class="py-keyword">in</tt> <tt id="link-121" class="py-name"><a title="epydoc.markup.restructuredtext.CONSOLIDATED_DEFLIST_FIELDS" class="py-name" href="#" onclick="return doclink('link-121', 'CONSOLIDATED_DEFLIST_FIELDS', 'link-25');">CONSOLIDATED_DEFLIST_FIELDS</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name" targets="Method epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_definition_list()=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#handle_consolidated_definition_list"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator.handle_consolidated_definition_list" class="py-name" href="#" onclick="return doclink('link-122', 'handle_consolidated_definition_list', 'link-122');">handle_consolidated_definition_list</a></tt><tt class="py-op">(</tt><tt id="link-123" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-123', 'body', 'link-42');">body</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">tagname</tt><tt class="py-op">)</tt> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tagname</tt> <tt class="py-keyword">in</tt> <tt id="link-124" class="py-name"><a title="epydoc.markup.restructuredtext.CONSOLIDATED_DEFLIST_FIELDS" class="py-name" href="#" onclick="return doclink('link-124', 'CONSOLIDATED_DEFLIST_FIELDS', 'link-25');">CONSOLIDATED_DEFLIST_FIELDS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'does not contain a bulleted list or '</tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"> <tt class="py-string">'definition list.'</tt><tt class="py-op">)</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'does not contain a bulleted list.'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L452"></a><tt class="py-lineno">452</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator.handle_consolidated_bullet_list"></a><div id="_SplitFieldsTranslator.handle_consolidated_bullet_list-def"><a name="L453"></a><tt class="py-lineno">453</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator.handle_consolidated_bullet_list-toggle" onclick="return toggle('_SplitFieldsTranslator.handle_consolidated_bullet_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#handle_consolidated_bullet_list">handle_consolidated_bullet_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">items</tt><tt class="py-op">,</tt> <tt class="py-param">tagname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator.handle_consolidated_bullet_list-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator.handle_consolidated_bullet_list-expanded"><a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"> <tt class="py-comment"># Check the contents of the list. In particular, each list</tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># item should have the form:</tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - `arg`: description...</tt> </tt>
<a name="L457"></a><tt class="py-lineno">457</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">n</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"> <tt class="py-name">_BAD_ITEM</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">"list item %d is not well formed. Each item must "</tt> </tt>
<a name="L459"></a><tt class="py-lineno">459</tt> <tt class="py-line"> <tt class="py-string">"consist of a single marked identifier (e.g., `x`), "</tt> </tt>
<a name="L460"></a><tt class="py-lineno">460</tt> <tt class="py-line"> <tt class="py-string">"optionally followed by a colon or dash and a "</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt> <tt class="py-line"> <tt class="py-string">"description."</tt><tt class="py-op">)</tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L463"></a><tt class="py-lineno">463</tt> <tt class="py-line"> <tt class="py-name">n</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L464"></a><tt class="py-lineno">464</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">item</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">!=</tt> <tt class="py-string">'list_item'</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L465"></a><tt class="py-lineno">465</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'bad bulleted list (bad child %d).'</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">!=</tt> <tt class="py-string">'paragraph'</tt><tt class="py-op">:</tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">==</tt> <tt class="py-string">'definition_list'</tt><tt class="py-op">:</tt> </tt>
<a name="L468"></a><tt class="py-lineno">468</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'list item %d contains a definition '</tt><tt class="py-op">+</tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt> <tt class="py-line"> <tt class="py-string">'list (it\'s probably indented '</tt><tt class="py-op">+</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt> <tt class="py-line"> <tt class="py-string">'wrong).'</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L471"></a><tt class="py-lineno">471</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L472"></a><tt class="py-lineno">472</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-name">_BAD_ITEM</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L473"></a><tt class="py-lineno">473</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-name">_BAD_ITEM</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">!=</tt> <tt class="py-string">'title_reference'</tt><tt class="py-op">:</tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-name">_BAD_ITEM</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L477"></a><tt class="py-lineno">477</tt> <tt class="py-line"> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt> <tt class="py-line"> <tt class="py-comment"># Everything looks good; convert to multiple fields.</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt> <tt class="py-line"> <tt class="py-comment"># Extract the arg</tt> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-125" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-125', 'arg', 'link-100');">arg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt> <tt class="py-line"> </tt>
<a name="L483"></a><tt class="py-lineno">483</tt> <tt class="py-line"> <tt class="py-comment"># Extract the field body, and remove the arg</tt> </tt>
<a name="L484"></a><tt class="py-lineno">484</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">fbody</tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L485"></a><tt class="py-lineno">485</tt> <tt class="py-line"> <tt class="py-name">fbody</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">fbody</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt> <tt class="py-line"> <tt class="py-name">fbody</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt> <tt class="py-line"> </tt>
<a name="L488"></a><tt class="py-lineno">488</tt> <tt class="py-line"> <tt class="py-comment"># Remove the separating ":", if present</tt> </tt>
<a name="L489"></a><tt class="py-lineno">489</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">fbody</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L490"></a><tt class="py-lineno">490</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">fbody</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">Text</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt> <tt class="py-line"> <tt class="py-name">child</tt> <tt class="py-op">=</tt> <tt class="py-name">fbody</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-string">':-'</tt><tt class="py-op">:</tt> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt> <tt class="py-line"> <tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">lstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L494"></a><tt class="py-lineno">494</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">' -'</tt><tt class="py-op">,</tt> <tt class="py-string">' :'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L495"></a><tt class="py-lineno">495</tt> <tt class="py-line"> <tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">lstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt> <tt class="py-line"> </tt>
<a name="L497"></a><tt class="py-lineno">497</tt> <tt class="py-line"> <tt class="py-comment"># Wrap the field body, and add a new field</tt> </tt>
<a name="L498"></a><tt class="py-lineno">498</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator._add_field" class="py-name" href="#" onclick="return doclink('link-126', '_add_field', 'link-110');">_add_field</a></tt><tt class="py-op">(</tt><tt class="py-name">tagname</tt><tt class="py-op">,</tt> <tt id="link-127" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-127', 'arg', 'link-100');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">fbody</tt><tt class="py-op">)</tt> </tt>
</div><a name="L499"></a><tt class="py-lineno">499</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator.handle_consolidated_definition_list"></a><div id="_SplitFieldsTranslator.handle_consolidated_definition_list-def"><a name="L500"></a><tt class="py-lineno">500</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator.handle_consolidated_definition_list-toggle" onclick="return toggle('_SplitFieldsTranslator.handle_consolidated_definition_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#handle_consolidated_definition_list">handle_consolidated_definition_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">items</tt><tt class="py-op">,</tt> <tt class="py-param">tagname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator.handle_consolidated_definition_list-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator.handle_consolidated_definition_list-expanded"><a name="L501"></a><tt class="py-lineno">501</tt> <tt class="py-line"> <tt class="py-comment"># Check the list contents.</tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">n</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L503"></a><tt class="py-lineno">503</tt> <tt class="py-line"> <tt class="py-name">_BAD_ITEM</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">"item %d is not well formed. Each item's term must "</tt> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt> <tt class="py-line"> <tt class="py-string">"consist of a single marked identifier (e.g., `x`), "</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt> <tt class="py-line"> <tt class="py-string">"optionally followed by a space, colon, space, and "</tt> </tt>
<a name="L506"></a><tt class="py-lineno">506</tt> <tt class="py-line"> <tt class="py-string">"a type description."</tt><tt class="py-op">)</tt> </tt>
<a name="L507"></a><tt class="py-lineno">507</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L508"></a><tt class="py-lineno">508</tt> <tt class="py-line"> <tt class="py-name">n</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L509"></a><tt class="py-lineno">509</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">!=</tt> <tt class="py-string">'definition_list_item'</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-number">2</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L510"></a><tt class="py-lineno">510</tt> <tt class="py-line"> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">!=</tt> <tt class="py-string">'term'</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt> <tt class="py-line"> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">!=</tt> <tt class="py-string">'definition'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L512"></a><tt class="py-lineno">512</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'bad definition list (bad child %d).'</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L513"></a><tt class="py-lineno">513</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">3</tt><tt class="py-op">:</tt> </tt>
<a name="L514"></a><tt class="py-lineno">514</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-name">_BAD_ITEM</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L515"></a><tt class="py-lineno">515</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">tagname</tt> <tt class="py-op">==</tt> <tt class="py-string">'title_reference'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L516"></a><tt class="py-lineno">516</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator.ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD" class="py-name" href="#" onclick="return doclink('link-128', 'ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD', 'link-94');">ALLOW_UNMARKED_ARG_IN_CONSOLIDATED_FIELD</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L517"></a><tt class="py-lineno">517</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">Text</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L518"></a><tt class="py-lineno">518</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-name">_BAD_ITEM</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L519"></a><tt class="py-lineno">519</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">child</tt> <tt class="py-keyword">in</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L520"></a><tt class="py-lineno">520</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">child</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L521"></a><tt class="py-lineno">521</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-name">_BAD_ITEM</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L522"></a><tt class="py-lineno">522</tt> <tt class="py-line"> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt> <tt class="py-line"> <tt class="py-comment"># Extract it.</tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt> <tt class="py-line"> <tt class="py-comment"># The basic field.</tt> </tt>
<a name="L526"></a><tt class="py-lineno">526</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-129" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-129', 'arg', 'link-100');">arg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt> <tt class="py-line"> <tt class="py-name">fbody</tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator._add_field" class="py-name" href="#" onclick="return doclink('link-130', '_add_field', 'link-110');">_add_field</a></tt><tt class="py-op">(</tt><tt class="py-name">tagname</tt><tt class="py-op">,</tt> <tt id="link-131" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-131', 'arg', 'link-100');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">fbody</tt><tt class="py-op">)</tt> </tt>
<a name="L529"></a><tt class="py-lineno">529</tt> <tt class="py-line"> <tt class="py-comment"># If there's a classifier, treat it as a type.</tt> </tt>
<a name="L530"></a><tt class="py-lineno">530</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">3</tt><tt class="py-op">:</tt> </tt>
<a name="L531"></a><tt class="py-lineno">531</tt> <tt class="py-line"> <tt id="link-132" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.type_descr=epydoc.apidoc.PropertyDoc-class.html#type_descr,Variable epydoc.apidoc.VariableDoc.type_descr=epydoc.apidoc.VariableDoc-class.html#type_descr,Method epydoc.docwriter.html.HTMLWriter.type_descr()=epydoc.docwriter.html.HTMLWriter-class.html#type_descr"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-132', 'type_descr', 'link-132');">type_descr</a></tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L532"></a><tt class="py-lineno">532</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-133" class="py-name"><a title="epydoc.markup.restructuredtext._SplitFieldsTranslator._add_field" class="py-name" href="#" onclick="return doclink('link-133', '_add_field', 'link-110');">_add_field</a></tt><tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt id="link-134" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-134', 'arg', 'link-100');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-135" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-135', 'type_descr', 'link-132');">type_descr</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L533"></a><tt class="py-lineno">533</tt> <tt class="py-line"> </tt>
<a name="_SplitFieldsTranslator.unknown_visit"></a><div id="_SplitFieldsTranslator.unknown_visit-def"><a name="L534"></a><tt class="py-lineno">534</tt> <a class="py-toggle" href="#" id="_SplitFieldsTranslator.unknown_visit-toggle" onclick="return toggle('_SplitFieldsTranslator.unknown_visit');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#unknown_visit">unknown_visit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_SplitFieldsTranslator.unknown_visit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_SplitFieldsTranslator.unknown_visit-expanded"><a name="L535"></a><tt class="py-lineno">535</tt> <tt class="py-line"> <tt class="py-docstring">'Ignore all unknown nodes'</tt> </tt>
</div></div><a name="L536"></a><tt class="py-lineno">536</tt> <tt class="py-line"> </tt>
<a name="latex_head_prefix"></a><div id="latex_head_prefix-def"><a name="L537"></a><tt class="py-lineno">537</tt> <a class="py-toggle" href="#" id="latex_head_prefix-toggle" onclick="return toggle('latex_head_prefix');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#latex_head_prefix">latex_head_prefix</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="latex_head_prefix-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="latex_head_prefix-expanded"><a name="L538"></a><tt class="py-lineno">538</tt> <tt class="py-line"> <tt id="link-136" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-136', 'document', 'link-30');">document</a></tt> <tt class="py-op">=</tt> <tt id="link-137" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.new_document" class="py-name" href="#" onclick="return doclink('link-137', 'new_document', 'link-2');">new_document</a></tt><tt class="py-op">(</tt><tt class="py-string">'<fake>'</tt><tt class="py-op">)</tt> </tt>
<a name="L539"></a><tt class="py-lineno">539</tt> <tt class="py-line"> <tt class="py-name">translator</tt> <tt class="py-op">=</tt> <tt id="link-138" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocLaTeXTranslator" class="py-name" href="#" onclick="return doclink('link-138', '_EpydocLaTeXTranslator', 'link-43');">_EpydocLaTeXTranslator</a></tt><tt class="py-op">(</tt><tt id="link-139" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-139', 'document', 'link-30');">document</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L540"></a><tt class="py-lineno">540</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">translator</tt><tt class="py-op">.</tt><tt class="py-name">head_prefix</tt> </tt>
</div><a name="L541"></a><tt class="py-lineno">541</tt> <tt class="py-line"> </tt>
<a name="_EpydocLaTeXTranslator"></a><div id="_EpydocLaTeXTranslator-def"><a name="L542"></a><tt class="py-lineno">542</tt> <a class="py-toggle" href="#" id="_EpydocLaTeXTranslator-toggle" onclick="return toggle('_EpydocLaTeXTranslator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html">_EpydocLaTeXTranslator</a><tt class="py-op">(</tt><tt class="py-base-class">LaTeXTranslator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocLaTeXTranslator-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_EpydocLaTeXTranslator-expanded"><a name="L543"></a><tt class="py-lineno">543</tt> <tt class="py-line"> <tt id="link-140" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-140', 'settings', 'link-59');">settings</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="_EpydocLaTeXTranslator.__init__"></a><div id="_EpydocLaTeXTranslator.__init__-def"><a name="L544"></a><tt class="py-lineno">544</tt> <a class="py-toggle" href="#" id="_EpydocLaTeXTranslator.__init__-toggle" onclick="return toggle('_EpydocLaTeXTranslator.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">document</tt><tt class="py-op">,</tt> <tt class="py-param">docstring_linker</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocLaTeXTranslator.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocLaTeXTranslator.__init__-expanded"><a name="L545"></a><tt class="py-lineno">545</tt> <tt class="py-line"> <tt class="py-comment"># Set the document's settings.</tt> </tt>
<a name="L546"></a><tt class="py-lineno">546</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-141', 'settings', 'link-59');">settings</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L547"></a><tt class="py-lineno">547</tt> <tt class="py-line"> <tt id="link-142" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-142', 'settings', 'link-59');">settings</a></tt> <tt class="py-op">=</tt> <tt class="py-name">OptionParser</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">LaTeXWriter</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">get_default_values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L548"></a><tt class="py-lineno">548</tt> <tt class="py-line"> <tt id="link-143" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-143', 'settings', 'link-59');">settings</a></tt><tt class="py-op">.</tt><tt class="py-name">output_encoding</tt> <tt class="py-op">=</tt> <tt class="py-string">'utf-8'</tt> </tt>
<a name="L549"></a><tt class="py-lineno">549</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt id="link-144" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-144', 'settings', 'link-59');">settings</a></tt> <tt class="py-op">=</tt> <tt id="link-145" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-145', 'settings', 'link-59');">settings</a></tt> </tt>
<a name="L550"></a><tt class="py-lineno">550</tt> <tt class="py-line"> <tt id="link-146" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-146', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt id="link-147" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-147', 'settings', 'link-59');">settings</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-148" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-148', 'settings', 'link-59');">settings</a></tt> </tt>
<a name="L551"></a><tt class="py-lineno">551</tt> <tt class="py-line"> </tt>
<a name="L552"></a><tt class="py-lineno">552</tt> <tt class="py-line"> <tt class="py-name">LaTeXTranslator</tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-149', '__init__', 'link-56');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-150" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-150', 'document', 'link-30');">document</a></tt><tt class="py-op">)</tt> </tt>
<a name="L553"></a><tt class="py-lineno">553</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_linker</tt> <tt class="py-op">=</tt> <tt class="py-name">docstring_linker</tt> </tt>
<a name="L554"></a><tt class="py-lineno">554</tt> <tt class="py-line"> </tt>
<a name="L555"></a><tt class="py-lineno">555</tt> <tt class="py-line"> <tt class="py-comment"># Start at section level 3. (Unfortunately, we now have to</tt> </tt>
<a name="L556"></a><tt class="py-lineno">556</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># set a private variable to make this work; perhaps the standard</tt> </tt>
<a name="L557"></a><tt class="py-lineno">557</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># latex translator should grow an official way to spell this?)</tt> </tt>
<a name="L558"></a><tt class="py-lineno">558</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">section_level</tt> <tt class="py-op">=</tt> <tt class="py-number">3</tt> </tt>
<a name="L559"></a><tt class="py-lineno">559</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_section_number</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">*</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">section_level</tt> </tt>
</div><a name="L560"></a><tt class="py-lineno">560</tt> <tt class="py-line"> </tt>
<a name="L561"></a><tt class="py-lineno">561</tt> <tt class="py-line"> <tt class="py-comment"># Handle interpreted text (crossreferences)</tt> </tt>
<a name="_EpydocLaTeXTranslator.visit_title_reference"></a><div id="_EpydocLaTeXTranslator.visit_title_reference-def"><a name="L562"></a><tt class="py-lineno">562</tt> <a class="py-toggle" href="#" id="_EpydocLaTeXTranslator.visit_title_reference-toggle" onclick="return toggle('_EpydocLaTeXTranslator.visit_title_reference');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#visit_title_reference">visit_title_reference</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocLaTeXTranslator.visit_title_reference-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocLaTeXTranslator.visit_title_reference-expanded"><a name="L563"></a><tt class="py-lineno">563</tt> <tt class="py-line"> <tt class="py-name">target</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L564"></a><tt class="py-lineno">564</tt> <tt class="py-line"> <tt class="py-name">xref</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_linker</tt><tt class="py-op">.</tt><tt id="link-151" class="py-name" targets="Method epydoc.docwriter.html._HTMLDocstringLinker.translate_identifier_xref()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref,Method epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_identifier_xref()=epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker-class.html#translate_identifier_xref,Method epydoc.markup.DocstringLinker.translate_identifier_xref()=epydoc.markup.DocstringLinker-class.html#translate_identifier_xref"><a title="epydoc.docwriter.html._HTMLDocstringLinker.translate_identifier_xref
epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_identifier_xref
epydoc.markup.DocstringLinker.translate_identifier_xref" class="py-name" href="#" onclick="return doclink('link-151', 'translate_identifier_xref', 'link-151');">translate_identifier_xref</a></tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt> </tt>
<a name="L565"></a><tt class="py-lineno">565</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-152', 'body', 'link-42');">body</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">xref</tt><tt class="py-op">)</tt> </tt>
<a name="L566"></a><tt class="py-lineno">566</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">SkipNode</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L567"></a><tt class="py-lineno">567</tt> <tt class="py-line"> </tt>
<a name="_EpydocLaTeXTranslator.visit_document"></a><div id="_EpydocLaTeXTranslator.visit_document-def"><a name="L568"></a><tt class="py-lineno">568</tt> <a class="py-toggle" href="#" id="_EpydocLaTeXTranslator.visit_document-toggle" onclick="return toggle('_EpydocLaTeXTranslator.visit_document');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#visit_document">visit_document</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="_EpydocLaTeXTranslator.depart_document"></a><div id="_EpydocLaTeXTranslator.depart_document-def"><a name="L569"></a><tt class="py-lineno">569</tt> <a class="py-toggle" href="#" id="_EpydocLaTeXTranslator.depart_document-toggle" onclick="return toggle('_EpydocLaTeXTranslator.depart_document');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#depart_document">depart_document</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L570"></a><tt class="py-lineno">570</tt> <tt class="py-line"> </tt>
<a name="L571"></a><tt class="py-lineno">571</tt> <tt class="py-line"> <tt class="py-comment"># For now, just ignore dotgraphs. [XXX]</tt> </tt>
<a name="_EpydocLaTeXTranslator.visit_dotgraph"></a><div id="_EpydocLaTeXTranslator.visit_dotgraph-def"><a name="L572"></a><tt class="py-lineno">572</tt> <a class="py-toggle" href="#" id="_EpydocLaTeXTranslator.visit_dotgraph-toggle" onclick="return toggle('_EpydocLaTeXTranslator.visit_dotgraph');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#visit_dotgraph">visit_dotgraph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocLaTeXTranslator.visit_dotgraph-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocLaTeXTranslator.visit_dotgraph-expanded"><a name="L573"></a><tt class="py-lineno">573</tt> <tt class="py-line"> <tt id="link-153" class="py-name" targets="Method epydoc.cli.ConsoleLogger.log()=epydoc.cli.ConsoleLogger-class.html#log,Method epydoc.cli.HTMLLogger.log()=epydoc.cli.HTMLLogger-class.html#log,Method epydoc.gui.GUILogger.log()=epydoc.gui.GUILogger-class.html#log,Module epydoc.log=epydoc.log-module.html,Method epydoc.log.Logger.log()=epydoc.log.Logger-class.html#log,Method epydoc.log.SimpleLogger.log()=epydoc.log.SimpleLogger-class.html#log"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-153', 'log', 'link-153');">log</a></tt><tt class="py-op">.</tt><tt id="link-154" class="py-name" targets="Method epydoc.checker.DocChecker.warning()=epydoc.checker.DocChecker-class.html#warning,Function epydoc.log.warning()=epydoc.log-module.html#warning"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-154', 'warning', 'link-154');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Ignoring dotgraph in latex output (dotgraph "</tt> </tt>
<a name="L574"></a><tt class="py-lineno">574</tt> <tt class="py-line"> <tt class="py-string">"rendering for latex not implemented yet)."</tt><tt class="py-op">)</tt> </tt>
<a name="L575"></a><tt class="py-lineno">575</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">SkipNode</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L576"></a><tt class="py-lineno">576</tt> <tt class="py-line"> </tt>
<a name="_EpydocLaTeXTranslator.visit_doctest_block"></a><div id="_EpydocLaTeXTranslator.visit_doctest_block-def"><a name="L577"></a><tt class="py-lineno">577</tt> <a class="py-toggle" href="#" id="_EpydocLaTeXTranslator.visit_doctest_block-toggle" onclick="return toggle('_EpydocLaTeXTranslator.visit_doctest_block');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#visit_doctest_block">visit_doctest_block</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocLaTeXTranslator.visit_doctest_block-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocLaTeXTranslator.visit_doctest_block-expanded"><a name="L578"></a><tt class="py-lineno">578</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-155', 'body', 'link-42');">body</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-156" class="py-name"><a title="epydoc.markup.doctest.doctest_to_latex" class="py-name" href="#" onclick="return doclink('link-156', 'doctest_to_latex', 'link-22');">doctest_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L579"></a><tt class="py-lineno">579</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">SkipNode</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L580"></a><tt class="py-lineno">580</tt> <tt class="py-line"> </tt>
<a name="_EpydocHTMLTranslator"></a><div id="_EpydocHTMLTranslator-def"><a name="L581"></a><tt class="py-lineno">581</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator-toggle" onclick="return toggle('_EpydocHTMLTranslator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html">_EpydocHTMLTranslator</a><tt class="py-op">(</tt><tt class="py-base-class">HTMLTranslator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocHTMLTranslator-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_EpydocHTMLTranslator-expanded"><a name="L582"></a><tt class="py-lineno">582</tt> <tt class="py-line"> <tt id="link-157" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-157', 'settings', 'link-59');">settings</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="_EpydocHTMLTranslator.__init__"></a><div id="_EpydocHTMLTranslator.__init__-def"><a name="L583"></a><tt class="py-lineno">583</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.__init__-toggle" onclick="return toggle('_EpydocHTMLTranslator.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">document</tt><tt class="py-op">,</tt> <tt class="py-param">docstring_linker</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">,</tt> </tt>
<a name="L584"></a><tt class="py-lineno">584</tt> <tt class="py-line"> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocHTMLTranslator.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocHTMLTranslator.__init__-expanded"><a name="L585"></a><tt class="py-lineno">585</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_linker</tt> <tt class="py-op">=</tt> <tt class="py-name">docstring_linker</tt> </tt>
<a name="L586"></a><tt class="py-lineno">586</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_directory</tt> <tt class="py-op">=</tt> <tt class="py-name">directory</tt> </tt>
<a name="L587"></a><tt class="py-lineno">587</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_docindex</tt> <tt class="py-op">=</tt> <tt class="py-name">docindex</tt> </tt>
<a name="L588"></a><tt class="py-lineno">588</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_context</tt> <tt class="py-op">=</tt> <tt class="py-name">context</tt> </tt>
<a name="L589"></a><tt class="py-lineno">589</tt> <tt class="py-line"> </tt>
<a name="L590"></a><tt class="py-lineno">590</tt> <tt class="py-line"> <tt class="py-comment"># Set the document's settings.</tt> </tt>
<a name="L591"></a><tt class="py-lineno">591</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-158', 'settings', 'link-59');">settings</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L592"></a><tt class="py-lineno">592</tt> <tt class="py-line"> <tt id="link-159" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-159', 'settings', 'link-59');">settings</a></tt> <tt class="py-op">=</tt> <tt class="py-name">OptionParser</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-160" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter" class="py-name" href="#" onclick="return doclink('link-160', 'HTMLWriter', 'link-1');">HTMLWriter</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">get_default_values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L593"></a><tt class="py-lineno">593</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-161', 'settings', 'link-59');">settings</a></tt> <tt class="py-op">=</tt> <tt id="link-162" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-162', 'settings', 'link-59');">settings</a></tt> </tt>
<a name="L594"></a><tt class="py-lineno">594</tt> <tt class="py-line"> <tt id="link-163" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-163', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-164', 'settings', 'link-59');">settings</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-165" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-165', 'settings', 'link-59');">settings</a></tt> </tt>
<a name="L595"></a><tt class="py-lineno">595</tt> <tt class="py-line"> </tt>
<a name="L596"></a><tt class="py-lineno">596</tt> <tt class="py-line"> <tt class="py-comment"># Call the parent constructor.</tt> </tt>
<a name="L597"></a><tt class="py-lineno">597</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">HTMLTranslator</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-166', '__init__', 'link-56');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-167" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-167', 'document', 'link-30');">document</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L598"></a><tt class="py-lineno">598</tt> <tt class="py-line"> </tt>
<a name="L599"></a><tt class="py-lineno">599</tt> <tt class="py-line"> <tt class="py-comment"># Handle interpreted text (crossreferences)</tt> </tt>
<a name="_EpydocHTMLTranslator.visit_title_reference"></a><div id="_EpydocHTMLTranslator.visit_title_reference-def"><a name="L600"></a><tt class="py-lineno">600</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.visit_title_reference-toggle" onclick="return toggle('_EpydocHTMLTranslator.visit_title_reference');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#visit_title_reference">visit_title_reference</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocHTMLTranslator.visit_title_reference-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocHTMLTranslator.visit_title_reference-expanded"><a name="L601"></a><tt class="py-lineno">601</tt> <tt class="py-line"> <tt class="py-name">target</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L602"></a><tt class="py-lineno">602</tt> <tt class="py-line"> <tt class="py-name">xref</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_linker</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="epydoc.docwriter.html._HTMLDocstringLinker.translate_identifier_xref
epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_identifier_xref
epydoc.markup.DocstringLinker.translate_identifier_xref" class="py-name" href="#" onclick="return doclink('link-168', 'translate_identifier_xref', 'link-151');">translate_identifier_xref</a></tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt> </tt>
<a name="L603"></a><tt class="py-lineno">603</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-169', 'body', 'link-42');">body</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">xref</tt><tt class="py-op">)</tt> </tt>
<a name="L604"></a><tt class="py-lineno">604</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">SkipNode</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L605"></a><tt class="py-lineno">605</tt> <tt class="py-line"> </tt>
<a name="_EpydocHTMLTranslator.should_be_compact_paragraph"></a><div id="_EpydocHTMLTranslator.should_be_compact_paragraph-def"><a name="L606"></a><tt class="py-lineno">606</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.should_be_compact_paragraph-toggle" onclick="return toggle('_EpydocHTMLTranslator.should_be_compact_paragraph');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#should_be_compact_paragraph">should_be_compact_paragraph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocHTMLTranslator.should_be_compact_paragraph-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocHTMLTranslator.should_be_compact_paragraph-expanded"><a name="L607"></a><tt class="py-lineno">607</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-170" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-170', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">children</tt> <tt class="py-op">==</tt> <tt class="py-op">[</tt><tt class="py-name">node</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L608"></a><tt class="py-lineno">608</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L609"></a><tt class="py-lineno">609</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L610"></a><tt class="py-lineno">610</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">HTMLTranslator</tt><tt class="py-op">.</tt><tt id="link-171" class="py-name" targets="Method epydoc.markup.restructuredtext._EpydocHTMLTranslator.should_be_compact_paragraph()=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#should_be_compact_paragraph"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.should_be_compact_paragraph" class="py-name" href="#" onclick="return doclink('link-171', 'should_be_compact_paragraph', 'link-171');">should_be_compact_paragraph</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">node</tt><tt class="py-op">)</tt> </tt>
</div><a name="L611"></a><tt class="py-lineno">611</tt> <tt class="py-line"> </tt>
<a name="_EpydocHTMLTranslator.visit_document"></a><div id="_EpydocHTMLTranslator.visit_document-def"><a name="L612"></a><tt class="py-lineno">612</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.visit_document-toggle" onclick="return toggle('_EpydocHTMLTranslator.visit_document');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#visit_document">visit_document</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="_EpydocHTMLTranslator.depart_document"></a><div id="_EpydocHTMLTranslator.depart_document-def"><a name="L613"></a><tt class="py-lineno">613</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.depart_document-toggle" onclick="return toggle('_EpydocHTMLTranslator.depart_document');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#depart_document">depart_document</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L614"></a><tt class="py-lineno">614</tt> <tt class="py-line"> </tt>
<a name="_EpydocHTMLTranslator.starttag"></a><div id="_EpydocHTMLTranslator.starttag-def"><a name="L615"></a><tt class="py-lineno">615</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.starttag-toggle" onclick="return toggle('_EpydocHTMLTranslator.starttag');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#starttag">starttag</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">,</tt> <tt class="py-param">tagname</tt><tt class="py-op">,</tt> <tt class="py-param">suffix</tt><tt class="py-op">=</tt><tt class="py-string">'\n'</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">attributes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocHTMLTranslator.starttag-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocHTMLTranslator.starttag-expanded"><a name="L616"></a><tt class="py-lineno">616</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L617"></a><tt class="py-lineno">617</tt> <tt class="py-line"><tt class="py-docstring"> This modified version of starttag makes a few changes to HTML</tt> </tt>
<a name="L618"></a><tt class="py-lineno">618</tt> <tt class="py-line"><tt class="py-docstring"> tags, to prevent them from conflicting with epydoc. In particular:</tt> </tt>
<a name="L619"></a><tt class="py-lineno">619</tt> <tt class="py-line"><tt class="py-docstring"> - existing class attributes are prefixed with C{'rst-'}</tt> </tt>
<a name="L620"></a><tt class="py-lineno">620</tt> <tt class="py-line"><tt class="py-docstring"> - existing names are prefixed with C{'rst-'}</tt> </tt>
<a name="L621"></a><tt class="py-lineno">621</tt> <tt class="py-line"><tt class="py-docstring"> - hrefs starting with C{'#'} are prefixed with C{'rst-'}</tt> </tt>
<a name="L622"></a><tt class="py-lineno">622</tt> <tt class="py-line"><tt class="py-docstring"> - hrefs not starting with C{'#'} are given target='_top'</tt> </tt>
<a name="L623"></a><tt class="py-lineno">623</tt> <tt class="py-line"><tt class="py-docstring"> - all headings (C{<hM{n}>}) are given the css class C{'heading'}</tt> </tt>
<a name="L624"></a><tt class="py-lineno">624</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L625"></a><tt class="py-lineno">625</tt> <tt class="py-line"> <tt class="py-comment"># Get the list of all attribute dictionaries we need to munge.</tt> </tt>
<a name="L626"></a><tt class="py-lineno">626</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">attr_dicts</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">attributes</tt><tt class="py-op">]</tt> </tt>
<a name="L627"></a><tt class="py-lineno">627</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">,</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">Node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L628"></a><tt class="py-lineno">628</tt> <tt class="py-line"> <tt class="py-name">attr_dicts</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">attributes</tt><tt class="py-op">)</tt> </tt>
<a name="L629"></a><tt class="py-lineno">629</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">,</tt> <tt class="py-name">dict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L630"></a><tt class="py-lineno">630</tt> <tt class="py-line"> <tt class="py-name">attr_dicts</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">)</tt> </tt>
<a name="L631"></a><tt class="py-lineno">631</tt> <tt class="py-line"> <tt class="py-comment"># Munge each attribute dictionary. Unfortunately, we need to</tt> </tt>
<a name="L632"></a><tt class="py-lineno">632</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># iterate through attributes one at a time because some</tt> </tt>
<a name="L633"></a><tt class="py-lineno">633</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># versions of docutils don't case-normalize attributes.</tt> </tt>
<a name="L634"></a><tt class="py-lineno">634</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">attr_dict</tt> <tt class="py-keyword">in</tt> <tt class="py-name">attr_dicts</tt><tt class="py-op">:</tt> </tt>
<a name="L635"></a><tt class="py-lineno">635</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-172" class="py-name" targets="Variable epydoc.cli.key=epydoc.cli-module.html#key"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-172', 'key', 'link-172');">key</a></tt><tt class="py-op">,</tt> <tt class="py-name">val</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">attr_dict</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L636"></a><tt class="py-lineno">636</tt> <tt class="py-line"> <tt class="py-comment"># Prefix all CSS classes with "rst-"; and prefix all</tt> </tt>
<a name="L637"></a><tt class="py-lineno">637</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># names with "rst-" to avoid conflicts.</tt> </tt>
<a name="L638"></a><tt class="py-lineno">638</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-173" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-173', 'key', 'link-172');">key</a></tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'class'</tt><tt class="py-op">,</tt> <tt class="py-string">'id'</tt><tt class="py-op">,</tt> <tt class="py-string">'name'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L639"></a><tt class="py-lineno">639</tt> <tt class="py-line"> <tt class="py-name">attr_dict</tt><tt class="py-op">[</tt><tt id="link-174" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-174', 'key', 'link-172');">key</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'rst-%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">val</tt> </tt>
<a name="L640"></a><tt class="py-lineno">640</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-175" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-175', 'key', 'link-172');">key</a></tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'classes'</tt><tt class="py-op">,</tt> <tt class="py-string">'ids'</tt><tt class="py-op">,</tt> <tt class="py-string">'names'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L641"></a><tt class="py-lineno">641</tt> <tt class="py-line"> <tt class="py-name">attr_dict</tt><tt class="py-op">[</tt><tt id="link-176" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-176', 'key', 'link-172');">key</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'rst-%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">cls</tt> <tt class="py-keyword">for</tt> <tt class="py-name">cls</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val</tt><tt class="py-op">]</tt> </tt>
<a name="L642"></a><tt class="py-lineno">642</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-177" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-177', 'key', 'link-172');">key</a></tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">'href'</tt><tt class="py-op">:</tt> </tt>
<a name="L643"></a><tt class="py-lineno">643</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">attr_dict</tt><tt class="py-op">[</tt><tt id="link-178" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-178', 'key', 'link-172');">key</a></tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">==</tt><tt class="py-string">'#'</tt><tt class="py-op">:</tt> </tt>
<a name="L644"></a><tt class="py-lineno">644</tt> <tt class="py-line"> <tt class="py-name">attr_dict</tt><tt class="py-op">[</tt><tt id="link-179" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-179', 'key', 'link-172');">key</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'#rst-%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">attr_dict</tt><tt class="py-op">[</tt><tt id="link-180" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-180', 'key', 'link-172');">key</a></tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L645"></a><tt class="py-lineno">645</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L646"></a><tt class="py-lineno">646</tt> <tt class="py-line"> <tt class="py-comment"># If it's an external link, open it in a new</tt> </tt>
<a name="L647"></a><tt class="py-lineno">647</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># page.</tt> </tt>
<a name="L648"></a><tt class="py-lineno">648</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">attr_dict</tt><tt class="py-op">[</tt><tt class="py-string">'target'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'_top'</tt> </tt>
<a name="L649"></a><tt class="py-lineno">649</tt> <tt class="py-line"> </tt>
<a name="L650"></a><tt class="py-lineno">650</tt> <tt class="py-line"> <tt class="py-comment"># For headings, use class="heading"</tt> </tt>
<a name="L651"></a><tt class="py-lineno">651</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">r'^h\d+$'</tt><tt class="py-op">,</tt> <tt class="py-name">tagname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L652"></a><tt class="py-lineno">652</tt> <tt class="py-line"> <tt class="py-name">attributes</tt><tt class="py-op">[</tt><tt class="py-string">'class'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">attributes</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'class'</tt><tt class="py-op">,</tt><tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L653"></a><tt class="py-lineno">653</tt> <tt class="py-line"> <tt class="py-string">'heading'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L654"></a><tt class="py-lineno">654</tt> <tt class="py-line"> </tt>
<a name="L655"></a><tt class="py-lineno">655</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">HTMLTranslator</tt><tt class="py-op">.</tt><tt id="link-181" class="py-name" targets="Method epydoc.markup.restructuredtext._EpydocHTMLTranslator.starttag()=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#starttag"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.starttag" class="py-name" href="#" onclick="return doclink('link-181', 'starttag', 'link-181');">starttag</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">node</tt><tt class="py-op">,</tt> <tt class="py-name">tagname</tt><tt class="py-op">,</tt> <tt class="py-name">suffix</tt><tt class="py-op">,</tt> </tt>
<a name="L656"></a><tt class="py-lineno">656</tt> <tt class="py-line"> <tt class="py-op">**</tt><tt class="py-name">attributes</tt><tt class="py-op">)</tt> </tt>
</div><a name="L657"></a><tt class="py-lineno">657</tt> <tt class="py-line"> </tt>
<a name="_EpydocHTMLTranslator.visit_dotgraph"></a><div id="_EpydocHTMLTranslator.visit_dotgraph-def"><a name="L658"></a><tt class="py-lineno">658</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.visit_dotgraph-toggle" onclick="return toggle('_EpydocHTMLTranslator.visit_dotgraph');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#visit_dotgraph">visit_dotgraph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocHTMLTranslator.visit_dotgraph-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocHTMLTranslator.visit_dotgraph-expanded"><a name="L659"></a><tt class="py-lineno">659</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_directory</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-comment"># [xx] warning?</tt> </tt>
<a name="L660"></a><tt class="py-lineno">660</tt> <tt class="py-line"> </tt>
<a name="L661"></a><tt class="py-lineno">661</tt> <tt class="py-line"> <tt class="py-comment"># Generate the graph.</tt> </tt>
<a name="L662"></a><tt class="py-lineno">662</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-182" class="py-name" targets="Method epydoc.markup.restructuredtext.dotgraph.graph()=epydoc.markup.restructuredtext.dotgraph-class.html#graph"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-182', 'graph', 'link-182');">graph</a></tt> <tt class="py-op">=</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt id="link-183" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-183', 'graph', 'link-182');">graph</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_docindex</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_context</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_linker</tt><tt class="py-op">)</tt> </tt>
<a name="L663"></a><tt class="py-lineno">663</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-184" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-184', 'graph', 'link-182');">graph</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L664"></a><tt class="py-lineno">664</tt> <tt class="py-line"> </tt>
<a name="L665"></a><tt class="py-lineno">665</tt> <tt class="py-line"> <tt class="py-comment"># Write the graph.</tt> </tt>
<a name="L666"></a><tt class="py-lineno">666</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">image_url</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s.gif'</tt> <tt class="py-op">%</tt> <tt id="link-185" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-185', 'graph', 'link-182');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">uid</tt> </tt>
<a name="L667"></a><tt class="py-lineno">667</tt> <tt class="py-line"> <tt class="py-name">image_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-186" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-186', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_directory</tt><tt class="py-op">,</tt> <tt class="py-name">image_url</tt><tt class="py-op">)</tt> </tt>
<a name="L668"></a><tt class="py-lineno">668</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-187" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-187', 'body', 'link-42');">body</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-188" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-188', 'graph', 'link-182');">graph</a></tt><tt class="py-op">.</tt><tt id="link-189" class="py-name" targets="Method epydoc.docwriter.dotgraph.DotGraph.to_html()=epydoc.docwriter.dotgraph.DotGraph-class.html#to_html,Method epydoc.markup.ConcatenatedDocstring.to_html()=epydoc.markup.ConcatenatedDocstring-class.html#to_html,Method epydoc.markup.ParsedDocstring.to_html()=epydoc.markup.ParsedDocstring-class.html#to_html,Method epydoc.markup.epytext.ParsedEpytextDocstring.to_html()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html,Method epydoc.markup.javadoc.ParsedJavadocDocstring.to_html()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#to_html,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html,Method epydoc.markup.restructuredtext.ParsedRstDocstring.to_html()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_html"><a title="epydoc.docwriter.dotgraph.DotGraph.to_html
epydoc.markup.ConcatenatedDocstring.to_html
epydoc.markup.ParsedDocstring.to_html
epydoc.markup.epytext.ParsedEpytextDocstring.to_html
epydoc.markup.javadoc.ParsedJavadocDocstring.to_html
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html
epydoc.markup.restructuredtext.ParsedRstDocstring.to_html" class="py-name" href="#" onclick="return doclink('link-189', 'to_html', 'link-189');">to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">image_file</tt><tt class="py-op">,</tt> <tt class="py-name">image_url</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L669"></a><tt class="py-lineno">669</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">SkipNode</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L670"></a><tt class="py-lineno">670</tt> <tt class="py-line"> </tt>
<a name="_EpydocHTMLTranslator.visit_doctest_block"></a><div id="_EpydocHTMLTranslator.visit_doctest_block-def"><a name="L671"></a><tt class="py-lineno">671</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.visit_doctest_block-toggle" onclick="return toggle('_EpydocHTMLTranslator.visit_doctest_block');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#visit_doctest_block">visit_doctest_block</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocHTMLTranslator.visit_doctest_block-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocHTMLTranslator.visit_doctest_block-expanded"><a name="L672"></a><tt class="py-lineno">672</tt> <tt class="py-line"> <tt class="py-name">pysrc</tt> <tt class="py-op">=</tt> <tt class="py-name">node</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">astext</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L673"></a><tt class="py-lineno">673</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'codeblock'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L674"></a><tt class="py-lineno">674</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-190" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-190', 'body', 'link-42');">body</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-191" class="py-name"><a title="epydoc.markup.doctest.HTMLDoctestColorizer" class="py-name" href="#" onclick="return doclink('link-191', 'HTMLDoctestColorizer', 'link-23');">HTMLDoctestColorizer</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-192" class="py-name" targets="Method epydoc.markup.doctest.DoctestColorizer.colorize_codeblock()=epydoc.markup.doctest.DoctestColorizer-class.html#colorize_codeblock"><a title="epydoc.markup.doctest.DoctestColorizer.colorize_codeblock" class="py-name" href="#" onclick="return doclink('link-192', 'colorize_codeblock', 'link-192');">colorize_codeblock</a></tt><tt class="py-op">(</tt><tt class="py-name">pysrc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L675"></a><tt class="py-lineno">675</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L676"></a><tt class="py-lineno">676</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-193" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-193', 'body', 'link-42');">body</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-194" class="py-name"><a title="epydoc.markup.doctest.doctest_to_html" class="py-name" href="#" onclick="return doclink('link-194', 'doctest_to_html', 'link-21');">doctest_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">pysrc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L677"></a><tt class="py-lineno">677</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">SkipNode</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L678"></a><tt class="py-lineno">678</tt> <tt class="py-line"> </tt>
<a name="_EpydocHTMLTranslator.visit_emphasis"></a><div id="_EpydocHTMLTranslator.visit_emphasis-def"><a name="L679"></a><tt class="py-lineno">679</tt> <a class="py-toggle" href="#" id="_EpydocHTMLTranslator.visit_emphasis-toggle" onclick="return toggle('_EpydocHTMLTranslator.visit_emphasis');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#visit_emphasis">visit_emphasis</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_EpydocHTMLTranslator.visit_emphasis-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="_EpydocHTMLTranslator.visit_emphasis-expanded"><a name="L680"></a><tt class="py-lineno">680</tt> <tt class="py-line"> <tt class="py-comment"># Generate a corrent index term anchor</tt> </tt>
<a name="L681"></a><tt class="py-lineno">681</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-string">'term'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'classes'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">:</tt> </tt>
<a name="L682"></a><tt class="py-lineno">682</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-195" class="py-name"><a title="epydoc.gui.document" class="py-name" href="#" onclick="return doclink('link-195', 'document', 'link-30');">document</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L683"></a><tt class="py-lineno">683</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L684"></a><tt class="py-lineno">684</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-196" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-196', 'body', 'link-42');">body</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> </tt>
<a name="L685"></a><tt class="py-lineno">685</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_linker</tt><tt class="py-op">.</tt><tt id="link-197" class="py-name" targets="Method epydoc.docwriter.html._HTMLDocstringLinker.translate_indexterm()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_indexterm,Method epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_indexterm()=epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker-class.html#translate_indexterm,Method epydoc.markup.DocstringLinker.translate_indexterm()=epydoc.markup.DocstringLinker-class.html#translate_indexterm"><a title="epydoc.docwriter.html._HTMLDocstringLinker.translate_indexterm
epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_indexterm
epydoc.markup.DocstringLinker.translate_indexterm" class="py-name" href="#" onclick="return doclink('link-197', 'translate_indexterm', 'link-197');">translate_indexterm</a></tt><tt class="py-op">(</tt><tt id="link-198" class="py-name"><a title="epydoc.markup.restructuredtext.ParsedRstDocstring" class="py-name" href="#" onclick="return doclink('link-198', 'ParsedRstDocstring', 'link-29');">ParsedRstDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L686"></a><tt class="py-lineno">686</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">SkipNode</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L687"></a><tt class="py-lineno">687</tt> <tt class="py-line"> </tt>
<a name="L688"></a><tt class="py-lineno">688</tt> <tt class="py-line"> <tt class="py-name">HTMLTranslator</tt><tt class="py-op">.</tt><tt id="link-199" class="py-name" targets="Method epydoc.markup.restructuredtext._EpydocHTMLTranslator.visit_emphasis()=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#visit_emphasis,Method epydoc.markup.restructuredtext._TermsExtractor.visit_emphasis()=epydoc.markup.restructuredtext._TermsExtractor-class.html#visit_emphasis"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.visit_emphasis
epydoc.markup.restructuredtext._TermsExtractor.visit_emphasis" class="py-name" href="#" onclick="return doclink('link-199', 'visit_emphasis', 'link-199');">visit_emphasis</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">node</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L689"></a><tt class="py-lineno">689</tt> <tt class="py-line"> </tt>
<a name="python_code_directive"></a><div id="python_code_directive-def"><a name="L690"></a><tt class="py-lineno">690</tt> <a class="py-toggle" href="#" id="python_code_directive-toggle" onclick="return toggle('python_code_directive');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#python_code_directive">python_code_directive</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L691"></a><tt class="py-lineno">691</tt> <tt class="py-line"> <tt class="py-param">content_offset</tt><tt class="py-op">,</tt> <tt class="py-param">block_text</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">,</tt> <tt class="py-param">state_machine</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="python_code_directive-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="python_code_directive-expanded"><a name="L692"></a><tt class="py-lineno">692</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L693"></a><tt class="py-lineno">693</tt> <tt class="py-line"><tt class="py-docstring"> A custom restructuredtext directive which can be used to display</tt> </tt>
<a name="L694"></a><tt class="py-lineno">694</tt> <tt class="py-line"><tt class="py-docstring"> syntax-highlighted Python code blocks. This directive takes no</tt> </tt>
<a name="L695"></a><tt class="py-lineno">695</tt> <tt class="py-line"><tt class="py-docstring"> arguments, and the body should contain only Python code. This</tt> </tt>
<a name="L696"></a><tt class="py-lineno">696</tt> <tt class="py-line"><tt class="py-docstring"> directive can be used instead of doctest blocks when it is</tt> </tt>
<a name="L697"></a><tt class="py-lineno">697</tt> <tt class="py-line"><tt class="py-docstring"> inconvenient to list prompts on each line, or when you would</tt> </tt>
<a name="L698"></a><tt class="py-lineno">698</tt> <tt class="py-line"><tt class="py-docstring"> prefer that the output not contain prompts (e.g., to make</tt> </tt>
<a name="L699"></a><tt class="py-lineno">699</tt> <tt class="py-line"><tt class="py-docstring"> copy/paste easier).</tt> </tt>
<a name="L700"></a><tt class="py-lineno">700</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L701"></a><tt class="py-lineno">701</tt> <tt class="py-line"> <tt class="py-name">required_arguments</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L702"></a><tt class="py-lineno">702</tt> <tt class="py-line"> <tt class="py-name">optional_arguments</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L703"></a><tt class="py-lineno">703</tt> <tt class="py-line"> </tt>
<a name="L704"></a><tt class="py-lineno">704</tt> <tt class="py-line"> <tt class="py-name">text</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
<a name="L705"></a><tt class="py-lineno">705</tt> <tt class="py-line"> <tt class="py-name">node</tt> <tt class="py-op">=</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">doctest_block</tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-name">codeblock</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L706"></a><tt class="py-lineno">706</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt> <tt class="py-name">node</tt> <tt class="py-op">]</tt> </tt>
</div><a name="L707"></a><tt class="py-lineno">707</tt> <tt class="py-line"> </tt>
<a name="L708"></a><tt class="py-lineno">708</tt> <tt class="py-line"><tt id="link-200" class="py-name" targets="Function epydoc.markup.restructuredtext.python_code_directive()=epydoc.markup.restructuredtext-module.html#python_code_directive"><a title="epydoc.markup.restructuredtext.python_code_directive" class="py-name" href="#" onclick="return doclink('link-200', 'python_code_directive', 'link-200');">python_code_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">arguments</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L709"></a><tt class="py-lineno">709</tt> <tt class="py-line"><tt id="link-201" class="py-name"><a title="epydoc.markup.restructuredtext.python_code_directive" class="py-name" href="#" onclick="return doclink('link-201', 'python_code_directive', 'link-200');">python_code_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L710"></a><tt class="py-lineno">710</tt> <tt class="py-line"> </tt>
<a name="L711"></a><tt class="py-lineno">711</tt> <tt class="py-line"><tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">register_directive</tt><tt class="py-op">(</tt><tt class="py-string">'python'</tt><tt class="py-op">,</tt> <tt id="link-202" class="py-name"><a title="epydoc.markup.restructuredtext.python_code_directive" class="py-name" href="#" onclick="return doclink('link-202', 'python_code_directive', 'link-200');">python_code_directive</a></tt><tt class="py-op">)</tt> </tt>
<a name="L712"></a><tt class="py-lineno">712</tt> <tt class="py-line"> </tt>
<a name="term_role"></a><div id="term_role-def"><a name="L713"></a><tt class="py-lineno">713</tt> <a class="py-toggle" href="#" id="term_role-toggle" onclick="return toggle('term_role');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#term_role">term_role</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">rawtext</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> <tt class="py-param">inliner</tt><tt class="py-op">,</tt> </tt>
<a name="L714"></a><tt class="py-lineno">714</tt> <tt class="py-line"> <tt class="py-param">options</tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="term_role-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="term_role-expanded"><a name="L715"></a><tt class="py-lineno">715</tt> <tt class="py-line"> </tt>
<a name="L716"></a><tt class="py-lineno">716</tt> <tt class="py-line"> <tt class="py-name">text</tt> <tt class="py-op">=</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">utils</tt><tt class="py-op">.</tt><tt class="py-name">unescape</tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">)</tt> </tt>
<a name="L717"></a><tt class="py-lineno">717</tt> <tt class="py-line"> <tt class="py-name">node</tt> <tt class="py-op">=</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">emphasis</tt><tt class="py-op">(</tt><tt class="py-name">rawtext</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
<a name="L718"></a><tt class="py-lineno">718</tt> <tt class="py-line"> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">attributes</tt><tt class="py-op">[</tt><tt class="py-string">'classes'</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'term'</tt><tt class="py-op">)</tt> </tt>
<a name="L719"></a><tt class="py-lineno">719</tt> <tt class="py-line"> </tt>
<a name="L720"></a><tt class="py-lineno">720</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">node</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L721"></a><tt class="py-lineno">721</tt> <tt class="py-line"> </tt>
<a name="L722"></a><tt class="py-lineno">722</tt> <tt class="py-line"><tt class="py-name">roles</tt><tt class="py-op">.</tt><tt class="py-name">register_local_role</tt><tt class="py-op">(</tt><tt class="py-string">'term'</tt><tt class="py-op">,</tt> <tt id="link-203" class="py-name" targets="Function epydoc.markup.restructuredtext.term_role()=epydoc.markup.restructuredtext-module.html#term_role"><a title="epydoc.markup.restructuredtext.term_role" class="py-name" href="#" onclick="return doclink('link-203', 'term_role', 'link-203');">term_role</a></tt><tt class="py-op">)</tt> </tt>
<a name="L723"></a><tt class="py-lineno">723</tt> <tt class="py-line"> </tt>
<a name="L724"></a><tt class="py-lineno">724</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L725"></a><tt class="py-lineno">725</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Graph Generation Directives</tt> </tt>
<a name="L726"></a><tt class="py-lineno">726</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L727"></a><tt class="py-lineno">727</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># See http://docutils.sourceforge.net/docs/howto/rst-directives.html</tt> </tt>
<a name="L728"></a><tt class="py-lineno">728</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="dotgraph"></a><div id="dotgraph-def"><a name="L729"></a><tt class="py-lineno">729</tt> <a class="py-toggle" href="#" id="dotgraph-toggle" onclick="return toggle('dotgraph');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.dotgraph-class.html">dotgraph</a><tt class="py-op">(</tt><tt class="py-base-class">docutils</tt><tt class="py-op">.</tt><tt class="py-base-class">nodes</tt><tt class="py-op">.</tt><tt class="py-base-class">image</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="dotgraph-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="dotgraph-expanded"><a name="L730"></a><tt class="py-lineno">730</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L731"></a><tt class="py-lineno">731</tt> <tt class="py-line"><tt class="py-docstring"> A custom docutils node that should be rendered using Graphviz dot.</tt> </tt>
<a name="L732"></a><tt class="py-lineno">732</tt> <tt class="py-line"><tt class="py-docstring"> This node does not directly store the graph; instead, it stores a</tt> </tt>
<a name="L733"></a><tt class="py-lineno">733</tt> <tt class="py-line"><tt class="py-docstring"> pointer to a function that can be used to generate the graph.</tt> </tt>
<a name="L734"></a><tt class="py-lineno">734</tt> <tt class="py-line"><tt class="py-docstring"> This allows the graph to be built based on information that might</tt> </tt>
<a name="L735"></a><tt class="py-lineno">735</tt> <tt class="py-line"><tt class="py-docstring"> not be available yet at parse time. This graph generation</tt> </tt>
<a name="L736"></a><tt class="py-lineno">736</tt> <tt class="py-line"><tt class="py-docstring"> function has the following signature:</tt> </tt>
<a name="L737"></a><tt class="py-lineno">737</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L738"></a><tt class="py-lineno">738</tt> <tt class="py-line"><tt class="py-docstring"> >>> def generate_graph(docindex, context, linker, *args):</tt> </tt>
<a name="L739"></a><tt class="py-lineno">739</tt> <tt class="py-line"><tt class="py-docstring"> ... 'generates and returns a new DotGraph'</tt> </tt>
<a name="L740"></a><tt class="py-lineno">740</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L741"></a><tt class="py-lineno">741</tt> <tt class="py-line"><tt class="py-docstring"> Where C{docindex} is a docindex containing the documentation that</tt> </tt>
<a name="L742"></a><tt class="py-lineno">742</tt> <tt class="py-line"><tt class="py-docstring"> epydoc has built; C{context} is the C{APIDoc} whose docstring</tt> </tt>
<a name="L743"></a><tt class="py-lineno">743</tt> <tt class="py-line"><tt class="py-docstring"> contains this dotgraph node; C{linker} is a L{DocstringLinker}</tt> </tt>
<a name="L744"></a><tt class="py-lineno">744</tt> <tt class="py-line"><tt class="py-docstring"> that can be used to resolve crossreferences; and C{args} is any</tt> </tt>
<a name="L745"></a><tt class="py-lineno">745</tt> <tt class="py-line"><tt class="py-docstring"> extra arguments that are passed to the C{dotgraph} constructor.</tt> </tt>
<a name="L746"></a><tt class="py-lineno">746</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="dotgraph.__init__"></a><div id="dotgraph.__init__-def"><a name="L747"></a><tt class="py-lineno">747</tt> <a class="py-toggle" href="#" id="dotgraph.__init__-toggle" onclick="return toggle('dotgraph.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.dotgraph-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">generate_graph_func</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">generate_graph_args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="dotgraph.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="dotgraph.__init__-expanded"><a name="L748"></a><tt class="py-lineno">748</tt> <tt class="py-line"> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">image</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-204', '__init__', 'link-56');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L749"></a><tt class="py-lineno">749</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">graph_func</tt> <tt class="py-op">=</tt> <tt class="py-name">generate_graph_func</tt> </tt>
<a name="L750"></a><tt class="py-lineno">750</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-name">generate_graph_args</tt> </tt>
</div><a name="dotgraph.graph"></a><div id="dotgraph.graph-def"><a name="L751"></a><tt class="py-lineno">751</tt> <a class="py-toggle" href="#" id="dotgraph.graph-toggle" onclick="return toggle('dotgraph.graph');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext.dotgraph-class.html#graph">graph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">,</tt> <tt class="py-param">linker</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="dotgraph.graph-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="dotgraph.graph-expanded"><a name="L752"></a><tt class="py-lineno">752</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">graph_func</tt><tt class="py-op">(</tt><tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L753"></a><tt class="py-lineno">753</tt> <tt class="py-line"> </tt>
<a name="_dir_option"></a><div id="_dir_option-def"><a name="L754"></a><tt class="py-lineno">754</tt> <a class="py-toggle" href="#" id="_dir_option-toggle" onclick="return toggle('_dir_option');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#_dir_option">_dir_option</a><tt class="py-op">(</tt><tt class="py-param">argument</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_dir_option-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_dir_option-expanded"><a name="L755"></a><tt class="py-lineno">755</tt> <tt class="py-line"> <tt class="py-docstring">"""A directive option spec for the orientation of a graph."""</tt> </tt>
<a name="L756"></a><tt class="py-lineno">756</tt> <tt class="py-line"> <tt class="py-name">argument</tt> <tt class="py-op">=</tt> <tt class="py-name">argument</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L757"></a><tt class="py-lineno">757</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">argument</tt> <tt class="py-op">==</tt> <tt class="py-string">'right'</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'LR'</tt> </tt>
<a name="L758"></a><tt class="py-lineno">758</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">argument</tt> <tt class="py-op">==</tt> <tt class="py-string">'left'</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'RL'</tt> </tt>
<a name="L759"></a><tt class="py-lineno">759</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">argument</tt> <tt class="py-op">==</tt> <tt class="py-string">'down'</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'TB'</tt> </tt>
<a name="L760"></a><tt class="py-lineno">760</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">argument</tt> <tt class="py-op">==</tt> <tt class="py-string">'up'</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'BT'</tt> </tt>
<a name="L761"></a><tt class="py-lineno">761</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'%r unknown; choose from left, right, up, down'</tt> <tt class="py-op">%</tt> </tt>
<a name="L762"></a><tt class="py-lineno">762</tt> <tt class="py-line"> <tt class="py-name">argument</tt><tt class="py-op">)</tt> </tt>
</div><a name="L763"></a><tt class="py-lineno">763</tt> <tt class="py-line"> </tt>
<a name="digraph_directive"></a><div id="digraph_directive-def"><a name="L764"></a><tt class="py-lineno">764</tt> <a class="py-toggle" href="#" id="digraph_directive-toggle" onclick="return toggle('digraph_directive');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#digraph_directive">digraph_directive</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L765"></a><tt class="py-lineno">765</tt> <tt class="py-line"> <tt class="py-param">content_offset</tt><tt class="py-op">,</tt> <tt class="py-param">block_text</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">,</tt> <tt class="py-param">state_machine</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="digraph_directive-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="digraph_directive-expanded"><a name="L766"></a><tt class="py-lineno">766</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L767"></a><tt class="py-lineno">767</tt> <tt class="py-line"><tt class="py-docstring"> A custom restructuredtext directive which can be used to display</tt> </tt>
<a name="L768"></a><tt class="py-lineno">768</tt> <tt class="py-line"><tt class="py-docstring"> Graphviz dot graphs. This directive takes a single argument,</tt> </tt>
<a name="L769"></a><tt class="py-lineno">769</tt> <tt class="py-line"><tt class="py-docstring"> which is used as the graph's name. The contents of the directive</tt> </tt>
<a name="L770"></a><tt class="py-lineno">770</tt> <tt class="py-line"><tt class="py-docstring"> are used as the body of the graph. Any href attributes whose</tt> </tt>
<a name="L771"></a><tt class="py-lineno">771</tt> <tt class="py-line"><tt class="py-docstring"> value has the form <name> will be replaced by the URL of the object</tt> </tt>
<a name="L772"></a><tt class="py-lineno">772</tt> <tt class="py-line"><tt class="py-docstring"> with that name. Here's a simple example::</tt> </tt>
<a name="L773"></a><tt class="py-lineno">773</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L774"></a><tt class="py-lineno">774</tt> <tt class="py-line"><tt class="py-docstring"> .. digraph:: example_digraph</tt> </tt>
<a name="L775"></a><tt class="py-lineno">775</tt> <tt class="py-line"><tt class="py-docstring"> a -> b -> c</tt> </tt>
<a name="L776"></a><tt class="py-lineno">776</tt> <tt class="py-line"><tt class="py-docstring"> c -> a [dir=\"none\"]</tt> </tt>
<a name="L777"></a><tt class="py-lineno">777</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L778"></a><tt class="py-lineno">778</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arguments</tt><tt class="py-op">:</tt> <tt id="link-205" class="py-name" targets="Method epydoc.docwriter.plaintext.PlaintextWriter.title()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#title"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-205', 'title', 'link-205');">title</a></tt> <tt class="py-op">=</tt> <tt class="py-name">arguments</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L779"></a><tt class="py-lineno">779</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt id="link-206" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-206', 'title', 'link-205');">title</a></tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L780"></a><tt class="py-lineno">780</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt> <tt id="link-207" class="py-name"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-207', 'dotgraph', 'link-13');">dotgraph</a></tt><tt class="py-op">(</tt><tt id="link-208" class="py-name" targets="Function epydoc.markup.restructuredtext._construct_digraph()=epydoc.markup.restructuredtext-module.html#_construct_digraph"><a title="epydoc.markup.restructuredtext._construct_digraph" class="py-name" href="#" onclick="return doclink('link-208', '_construct_digraph', 'link-208');">_construct_digraph</a></tt><tt class="py-op">,</tt> <tt id="link-209" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-209', 'title', 'link-205');">title</a></tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'caption'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L781"></a><tt class="py-lineno">781</tt> <tt class="py-line"> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">]</tt> </tt>
</div><a name="L782"></a><tt class="py-lineno">782</tt> <tt class="py-line"><tt id="link-210" class="py-name" targets="Function epydoc.markup.restructuredtext.digraph_directive()=epydoc.markup.restructuredtext-module.html#digraph_directive"><a title="epydoc.markup.restructuredtext.digraph_directive" class="py-name" href="#" onclick="return doclink('link-210', 'digraph_directive', 'link-210');">digraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">arguments</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L783"></a><tt class="py-lineno">783</tt> <tt class="py-line"><tt id="link-211" class="py-name"><a title="epydoc.markup.restructuredtext.digraph_directive" class="py-name" href="#" onclick="return doclink('link-211', 'digraph_directive', 'link-210');">digraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">options</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'caption'</tt><tt class="py-op">:</tt> <tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">unchanged</tt><tt class="py-op">}</tt> </tt>
<a name="L784"></a><tt class="py-lineno">784</tt> <tt class="py-line"><tt id="link-212" class="py-name"><a title="epydoc.markup.restructuredtext.digraph_directive" class="py-name" href="#" onclick="return doclink('link-212', 'digraph_directive', 'link-210');">digraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L785"></a><tt class="py-lineno">785</tt> <tt class="py-line"><tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">register_directive</tt><tt class="py-op">(</tt><tt class="py-string">'digraph'</tt><tt class="py-op">,</tt> <tt id="link-213" class="py-name"><a title="epydoc.markup.restructuredtext.digraph_directive" class="py-name" href="#" onclick="return doclink('link-213', 'digraph_directive', 'link-210');">digraph_directive</a></tt><tt class="py-op">)</tt> </tt>
<a name="L786"></a><tt class="py-lineno">786</tt> <tt class="py-line"> </tt>
<a name="_construct_digraph"></a><div id="_construct_digraph-def"><a name="L787"></a><tt class="py-lineno">787</tt> <a class="py-toggle" href="#" id="_construct_digraph-toggle" onclick="return toggle('_construct_digraph');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#_construct_digraph">_construct_digraph</a><tt class="py-op">(</tt><tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">,</tt> <tt class="py-param">linker</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">caption</tt><tt class="py-op">,</tt> </tt>
<a name="L788"></a><tt class="py-lineno">788</tt> <tt class="py-line"> <tt class="py-param">body</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_construct_digraph-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_construct_digraph-expanded"><a name="L789"></a><tt class="py-lineno">789</tt> <tt class="py-line"> <tt class="py-docstring">"""Graph generator for L{digraph_directive}"""</tt> </tt>
<a name="L790"></a><tt class="py-lineno">790</tt> <tt class="py-line"> <tt id="link-214" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-214', 'graph', 'link-182');">graph</a></tt> <tt class="py-op">=</tt> <tt id="link-215" class="py-name" targets="Class epydoc.docwriter.dotgraph.DotGraph=epydoc.docwriter.dotgraph.DotGraph-class.html"><a title="epydoc.docwriter.dotgraph.DotGraph" class="py-name" href="#" onclick="return doclink('link-215', 'DotGraph', 'link-215');">DotGraph</a></tt><tt class="py-op">(</tt><tt id="link-216" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-216', 'title', 'link-205');">title</a></tt><tt class="py-op">,</tt> <tt id="link-217" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-217', 'body', 'link-42');">body</a></tt><tt class="py-op">,</tt> <tt class="py-name">caption</tt><tt class="py-op">=</tt><tt class="py-name">caption</tt><tt class="py-op">)</tt> </tt>
<a name="L791"></a><tt class="py-lineno">791</tt> <tt class="py-line"> <tt id="link-218" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-218', 'graph', 'link-182');">graph</a></tt><tt class="py-op">.</tt><tt id="link-219" class="py-name" targets="Method epydoc.docwriter.dotgraph.DotGraph.link()=epydoc.docwriter.dotgraph.DotGraph-class.html#link"><a title="epydoc.docwriter.dotgraph.DotGraph.link" class="py-name" href="#" onclick="return doclink('link-219', 'link', 'link-219');">link</a></tt><tt class="py-op">(</tt><tt class="py-name">linker</tt><tt class="py-op">)</tt> </tt>
<a name="L792"></a><tt class="py-lineno">792</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-220" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-220', 'graph', 'link-182');">graph</a></tt> </tt>
</div><a name="L793"></a><tt class="py-lineno">793</tt> <tt class="py-line"> </tt>
<a name="classtree_directive"></a><div id="classtree_directive-def"><a name="L794"></a><tt class="py-lineno">794</tt> <a class="py-toggle" href="#" id="classtree_directive-toggle" onclick="return toggle('classtree_directive');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#classtree_directive">classtree_directive</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L795"></a><tt class="py-lineno">795</tt> <tt class="py-line"> <tt class="py-param">content_offset</tt><tt class="py-op">,</tt> <tt class="py-param">block_text</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">,</tt> <tt class="py-param">state_machine</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="classtree_directive-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="classtree_directive-expanded"><a name="L796"></a><tt class="py-lineno">796</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L797"></a><tt class="py-lineno">797</tt> <tt class="py-line"><tt class="py-docstring"> A custom restructuredtext directive which can be used to</tt> </tt>
<a name="L798"></a><tt class="py-lineno">798</tt> <tt class="py-line"><tt class="py-docstring"> graphically display a class hierarchy. If one or more arguments</tt> </tt>
<a name="L799"></a><tt class="py-lineno">799</tt> <tt class="py-line"><tt class="py-docstring"> are given, then those classes and all their descendants will be</tt> </tt>
<a name="L800"></a><tt class="py-lineno">800</tt> <tt class="py-line"><tt class="py-docstring"> displayed. If no arguments are given, and the directive is in a</tt> </tt>
<a name="L801"></a><tt class="py-lineno">801</tt> <tt class="py-line"><tt class="py-docstring"> class's docstring, then that class and all its descendants will be</tt> </tt>
<a name="L802"></a><tt class="py-lineno">802</tt> <tt class="py-line"><tt class="py-docstring"> displayed. It is an error to use this directive with no arguments</tt> </tt>
<a name="L803"></a><tt class="py-lineno">803</tt> <tt class="py-line"><tt class="py-docstring"> in a non-class docstring.</tt> </tt>
<a name="L804"></a><tt class="py-lineno">804</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L805"></a><tt class="py-lineno">805</tt> <tt class="py-line"><tt class="py-docstring"> Options:</tt> </tt>
<a name="L806"></a><tt class="py-lineno">806</tt> <tt class="py-line"><tt class="py-docstring"> - C{:dir:} -- Specifies the orientation of the graph. One of</tt> </tt>
<a name="L807"></a><tt class="py-lineno">807</tt> <tt class="py-line"><tt class="py-docstring"> C{down}, C{right} (default), C{left}, C{up}.</tt> </tt>
<a name="L808"></a><tt class="py-lineno">808</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L809"></a><tt class="py-lineno">809</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt> <tt id="link-221" class="py-name"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-221', 'dotgraph', 'link-13');">dotgraph</a></tt><tt class="py-op">(</tt><tt id="link-222" class="py-name" targets="Function epydoc.markup.restructuredtext._construct_classtree()=epydoc.markup.restructuredtext-module.html#_construct_classtree"><a title="epydoc.markup.restructuredtext._construct_classtree" class="py-name" href="#" onclick="return doclink('link-222', '_construct_classtree', 'link-222');">_construct_classtree</a></tt><tt class="py-op">,</tt> <tt class="py-name">arguments</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">)</tt> <tt class="py-op">]</tt> </tt>
</div><a name="L810"></a><tt class="py-lineno">810</tt> <tt class="py-line"><tt id="link-223" class="py-name" targets="Function epydoc.markup.restructuredtext.classtree_directive()=epydoc.markup.restructuredtext-module.html#classtree_directive"><a title="epydoc.markup.restructuredtext.classtree_directive" class="py-name" href="#" onclick="return doclink('link-223', 'classtree_directive', 'link-223');">classtree_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">arguments</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L811"></a><tt class="py-lineno">811</tt> <tt class="py-line"><tt id="link-224" class="py-name"><a title="epydoc.markup.restructuredtext.classtree_directive" class="py-name" href="#" onclick="return doclink('link-224', 'classtree_directive', 'link-223');">classtree_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">options</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'dir'</tt><tt class="py-op">:</tt> <tt id="link-225" class="py-name" targets="Function epydoc.markup.restructuredtext._dir_option()=epydoc.markup.restructuredtext-module.html#_dir_option"><a title="epydoc.markup.restructuredtext._dir_option" class="py-name" href="#" onclick="return doclink('link-225', '_dir_option', 'link-225');">_dir_option</a></tt><tt class="py-op">}</tt> </tt>
<a name="L812"></a><tt class="py-lineno">812</tt> <tt class="py-line"><tt id="link-226" class="py-name"><a title="epydoc.markup.restructuredtext.classtree_directive" class="py-name" href="#" onclick="return doclink('link-226', 'classtree_directive', 'link-223');">classtree_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L813"></a><tt class="py-lineno">813</tt> <tt class="py-line"><tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">register_directive</tt><tt class="py-op">(</tt><tt class="py-string">'classtree'</tt><tt class="py-op">,</tt> <tt id="link-227" class="py-name"><a title="epydoc.markup.restructuredtext.classtree_directive" class="py-name" href="#" onclick="return doclink('link-227', 'classtree_directive', 'link-223');">classtree_directive</a></tt><tt class="py-op">)</tt> </tt>
<a name="L814"></a><tt class="py-lineno">814</tt> <tt class="py-line"> </tt>
<a name="_construct_classtree"></a><div id="_construct_classtree-def"><a name="L815"></a><tt class="py-lineno">815</tt> <a class="py-toggle" href="#" id="_construct_classtree-toggle" onclick="return toggle('_construct_classtree');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#_construct_classtree">_construct_classtree</a><tt class="py-op">(</tt><tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">,</tt> <tt class="py-param">linker</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_construct_classtree-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_construct_classtree-expanded"><a name="L816"></a><tt class="py-lineno">816</tt> <tt class="py-line"> <tt class="py-docstring">"""Graph generator for L{classtree_directive}"""</tt> </tt>
<a name="L817"></a><tt class="py-lineno">817</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">arguments</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L818"></a><tt class="py-lineno">818</tt> <tt class="py-line"> <tt id="link-228" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.bases=epydoc.apidoc.ClassDoc-class.html#bases"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-228', 'bases', 'link-228');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-229" class="py-name" targets="Method epydoc.apidoc.DocIndex.find()=epydoc.apidoc.DocIndex-class.html#find"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-229', 'find', 'link-229');">find</a></tt><tt class="py-op">(</tt><tt id="link-230" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.name=epydoc.apidoc.VariableDoc-class.html#name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-230', 'name', 'link-230');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-231" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-231', 'name', 'link-230');">name</a></tt> <tt class="py-keyword">in</tt> </tt>
<a name="L819"></a><tt class="py-lineno">819</tt> <tt class="py-line"> <tt class="py-name">arguments</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">','</tt><tt class="py-op">,</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L820"></a><tt class="py-lineno">820</tt> <tt class="py-line"> <tt id="link-232" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-232', 'bases', 'link-228');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt id="link-233" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-233', 'bases', 'link-228');">bases</a></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-234" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-234', 'ClassDoc', 'link-10');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L821"></a><tt class="py-lineno">821</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">context</tt><tt class="py-op">,</tt> <tt id="link-235" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-235', 'ClassDoc', 'link-10');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L822"></a><tt class="py-lineno">822</tt> <tt class="py-line"> <tt id="link-236" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-236', 'bases', 'link-228');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">context</tt><tt class="py-op">]</tt> </tt>
<a name="L823"></a><tt class="py-lineno">823</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L824"></a><tt class="py-lineno">824</tt> <tt class="py-line"> <tt id="link-237" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-237', 'log', 'link-153');">log</a></tt><tt class="py-op">.</tt><tt id="link-238" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-238', 'warning', 'link-154');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Could not construct class tree: you must "</tt> </tt>
<a name="L825"></a><tt class="py-lineno">825</tt> <tt class="py-line"> <tt class="py-string">"specify one or more base classes."</tt><tt class="py-op">)</tt> </tt>
<a name="L826"></a><tt class="py-lineno">826</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L827"></a><tt class="py-lineno">827</tt> <tt class="py-line"> </tt>
<a name="L828"></a><tt class="py-lineno">828</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-239" class="py-name" targets="Function epydoc.docwriter.dotgraph.class_tree_graph()=epydoc.docwriter.dotgraph-module.html#class_tree_graph"><a title="epydoc.docwriter.dotgraph.class_tree_graph" class="py-name" href="#" onclick="return doclink('link-239', 'class_tree_graph', 'link-239');">class_tree_graph</a></tt><tt class="py-op">(</tt><tt id="link-240" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-240', 'bases', 'link-228');">bases</a></tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
</div><a name="L829"></a><tt class="py-lineno">829</tt> <tt class="py-line"> </tt>
<a name="packagetree_directive"></a><div id="packagetree_directive-def"><a name="L830"></a><tt class="py-lineno">830</tt> <a class="py-toggle" href="#" id="packagetree_directive-toggle" onclick="return toggle('packagetree_directive');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#packagetree_directive">packagetree_directive</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L831"></a><tt class="py-lineno">831</tt> <tt class="py-line"> <tt class="py-param">content_offset</tt><tt class="py-op">,</tt> <tt class="py-param">block_text</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">,</tt> <tt class="py-param">state_machine</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="packagetree_directive-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="packagetree_directive-expanded"><a name="L832"></a><tt class="py-lineno">832</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L833"></a><tt class="py-lineno">833</tt> <tt class="py-line"><tt class="py-docstring"> A custom restructuredtext directive which can be used to</tt> </tt>
<a name="L834"></a><tt class="py-lineno">834</tt> <tt class="py-line"><tt class="py-docstring"> graphically display a package hierarchy. If one or more arguments</tt> </tt>
<a name="L835"></a><tt class="py-lineno">835</tt> <tt class="py-line"><tt class="py-docstring"> are given, then those packages and all their submodules will be</tt> </tt>
<a name="L836"></a><tt class="py-lineno">836</tt> <tt class="py-line"><tt class="py-docstring"> displayed. If no arguments are given, and the directive is in a</tt> </tt>
<a name="L837"></a><tt class="py-lineno">837</tt> <tt class="py-line"><tt class="py-docstring"> package's docstring, then that package and all its submodules will</tt> </tt>
<a name="L838"></a><tt class="py-lineno">838</tt> <tt class="py-line"><tt class="py-docstring"> be displayed. It is an error to use this directive with no</tt> </tt>
<a name="L839"></a><tt class="py-lineno">839</tt> <tt class="py-line"><tt class="py-docstring"> arguments in a non-package docstring.</tt> </tt>
<a name="L840"></a><tt class="py-lineno">840</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L841"></a><tt class="py-lineno">841</tt> <tt class="py-line"><tt class="py-docstring"> Options:</tt> </tt>
<a name="L842"></a><tt class="py-lineno">842</tt> <tt class="py-line"><tt class="py-docstring"> - C{:dir:} -- Specifies the orientation of the graph. One of</tt> </tt>
<a name="L843"></a><tt class="py-lineno">843</tt> <tt class="py-line"><tt class="py-docstring"> C{down}, C{right} (default), C{left}, C{up}.</tt> </tt>
<a name="L844"></a><tt class="py-lineno">844</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L845"></a><tt class="py-lineno">845</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt> <tt id="link-241" class="py-name"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-241', 'dotgraph', 'link-13');">dotgraph</a></tt><tt class="py-op">(</tt><tt id="link-242" class="py-name" targets="Function epydoc.markup.restructuredtext._construct_packagetree()=epydoc.markup.restructuredtext-module.html#_construct_packagetree"><a title="epydoc.markup.restructuredtext._construct_packagetree" class="py-name" href="#" onclick="return doclink('link-242', '_construct_packagetree', 'link-242');">_construct_packagetree</a></tt><tt class="py-op">,</tt> <tt class="py-name">arguments</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">)</tt> <tt class="py-op">]</tt> </tt>
</div><a name="L846"></a><tt class="py-lineno">846</tt> <tt class="py-line"><tt id="link-243" class="py-name" targets="Function epydoc.markup.restructuredtext.packagetree_directive()=epydoc.markup.restructuredtext-module.html#packagetree_directive"><a title="epydoc.markup.restructuredtext.packagetree_directive" class="py-name" href="#" onclick="return doclink('link-243', 'packagetree_directive', 'link-243');">packagetree_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">arguments</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L847"></a><tt class="py-lineno">847</tt> <tt class="py-line"><tt id="link-244" class="py-name"><a title="epydoc.markup.restructuredtext.packagetree_directive" class="py-name" href="#" onclick="return doclink('link-244', 'packagetree_directive', 'link-243');">packagetree_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">options</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L848"></a><tt class="py-lineno">848</tt> <tt class="py-line"> <tt class="py-string">'dir'</tt><tt class="py-op">:</tt> <tt id="link-245" class="py-name"><a title="epydoc.markup.restructuredtext._dir_option" class="py-name" href="#" onclick="return doclink('link-245', '_dir_option', 'link-225');">_dir_option</a></tt><tt class="py-op">,</tt> </tt>
<a name="L849"></a><tt class="py-lineno">849</tt> <tt class="py-line"> <tt class="py-string">'style'</tt><tt class="py-op">:</tt> <tt class="py-keyword">lambda</tt> <tt class="py-name">a</tt><tt class="py-op">:</tt><tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">choice</tt><tt class="py-op">(</tt><tt class="py-name">a</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-string">'uml'</tt><tt class="py-op">,</tt> <tt class="py-string">'tree'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">}</tt> </tt>
<a name="L850"></a><tt class="py-lineno">850</tt> <tt class="py-line"><tt id="link-246" class="py-name"><a title="epydoc.markup.restructuredtext.packagetree_directive" class="py-name" href="#" onclick="return doclink('link-246', 'packagetree_directive', 'link-243');">packagetree_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L851"></a><tt class="py-lineno">851</tt> <tt class="py-line"><tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">register_directive</tt><tt class="py-op">(</tt><tt class="py-string">'packagetree'</tt><tt class="py-op">,</tt> <tt id="link-247" class="py-name"><a title="epydoc.markup.restructuredtext.packagetree_directive" class="py-name" href="#" onclick="return doclink('link-247', 'packagetree_directive', 'link-243');">packagetree_directive</a></tt><tt class="py-op">)</tt> </tt>
<a name="L852"></a><tt class="py-lineno">852</tt> <tt class="py-line"> </tt>
<a name="_construct_packagetree"></a><div id="_construct_packagetree-def"><a name="L853"></a><tt class="py-lineno">853</tt> <a class="py-toggle" href="#" id="_construct_packagetree-toggle" onclick="return toggle('_construct_packagetree');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#_construct_packagetree">_construct_packagetree</a><tt class="py-op">(</tt><tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">,</tt> <tt class="py-param">linker</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_construct_packagetree-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_construct_packagetree-expanded"><a name="L854"></a><tt class="py-lineno">854</tt> <tt class="py-line"> <tt class="py-docstring">"""Graph generator for L{packagetree_directive}"""</tt> </tt>
<a name="L855"></a><tt class="py-lineno">855</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">arguments</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L856"></a><tt class="py-lineno">856</tt> <tt class="py-line"> <tt class="py-name">packages</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-248" class="py-name"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-248', 'find', 'link-229');">find</a></tt><tt class="py-op">(</tt><tt id="link-249" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-249', 'name', 'link-230');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-250" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-250', 'name', 'link-230');">name</a></tt> <tt class="py-keyword">in</tt> </tt>
<a name="L857"></a><tt class="py-lineno">857</tt> <tt class="py-line"> <tt class="py-name">arguments</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">','</tt><tt class="py-op">,</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L858"></a><tt class="py-lineno">858</tt> <tt class="py-line"> <tt class="py-name">packages</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">packages</tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-251" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-251', 'ModuleDoc', 'link-9');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L859"></a><tt class="py-lineno">859</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">context</tt><tt class="py-op">,</tt> <tt id="link-252" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-252', 'ModuleDoc', 'link-9');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L860"></a><tt class="py-lineno">860</tt> <tt class="py-line"> <tt class="py-name">packages</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">context</tt><tt class="py-op">]</tt> </tt>
<a name="L861"></a><tt class="py-lineno">861</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L862"></a><tt class="py-lineno">862</tt> <tt class="py-line"> <tt id="link-253" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-253', 'log', 'link-153');">log</a></tt><tt class="py-op">.</tt><tt id="link-254" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-254', 'warning', 'link-154');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Could not construct package tree: you must "</tt> </tt>
<a name="L863"></a><tt class="py-lineno">863</tt> <tt class="py-line"> <tt class="py-string">"specify one or more root packages."</tt><tt class="py-op">)</tt> </tt>
<a name="L864"></a><tt class="py-lineno">864</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L865"></a><tt class="py-lineno">865</tt> <tt class="py-line"> </tt>
<a name="L866"></a><tt class="py-lineno">866</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-255" class="py-name" targets="Function epydoc.docwriter.dotgraph.package_tree_graph()=epydoc.docwriter.dotgraph-module.html#package_tree_graph"><a title="epydoc.docwriter.dotgraph.package_tree_graph" class="py-name" href="#" onclick="return doclink('link-255', 'package_tree_graph', 'link-255');">package_tree_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">packages</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
</div><a name="L867"></a><tt class="py-lineno">867</tt> <tt class="py-line"> </tt>
<a name="importgraph_directive"></a><div id="importgraph_directive-def"><a name="L868"></a><tt class="py-lineno">868</tt> <a class="py-toggle" href="#" id="importgraph_directive-toggle" onclick="return toggle('importgraph_directive');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#importgraph_directive">importgraph_directive</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L869"></a><tt class="py-lineno">869</tt> <tt class="py-line"> <tt class="py-param">content_offset</tt><tt class="py-op">,</tt> <tt class="py-param">block_text</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">,</tt> <tt class="py-param">state_machine</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="importgraph_directive-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="importgraph_directive-expanded"><a name="L870"></a><tt class="py-lineno">870</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt> <tt id="link-256" class="py-name"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-256', 'dotgraph', 'link-13');">dotgraph</a></tt><tt class="py-op">(</tt><tt id="link-257" class="py-name" targets="Function epydoc.markup.restructuredtext._construct_importgraph()=epydoc.markup.restructuredtext-module.html#_construct_importgraph"><a title="epydoc.markup.restructuredtext._construct_importgraph" class="py-name" href="#" onclick="return doclink('link-257', '_construct_importgraph', 'link-257');">_construct_importgraph</a></tt><tt class="py-op">,</tt> <tt class="py-name">arguments</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">)</tt> <tt class="py-op">]</tt> </tt>
</div><a name="L871"></a><tt class="py-lineno">871</tt> <tt class="py-line"><tt id="link-258" class="py-name" targets="Function epydoc.markup.restructuredtext.importgraph_directive()=epydoc.markup.restructuredtext-module.html#importgraph_directive"><a title="epydoc.markup.restructuredtext.importgraph_directive" class="py-name" href="#" onclick="return doclink('link-258', 'importgraph_directive', 'link-258');">importgraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">arguments</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L872"></a><tt class="py-lineno">872</tt> <tt class="py-line"><tt id="link-259" class="py-name"><a title="epydoc.markup.restructuredtext.importgraph_directive" class="py-name" href="#" onclick="return doclink('link-259', 'importgraph_directive', 'link-258');">importgraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">options</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'dir'</tt><tt class="py-op">:</tt> <tt id="link-260" class="py-name"><a title="epydoc.markup.restructuredtext._dir_option" class="py-name" href="#" onclick="return doclink('link-260', '_dir_option', 'link-225');">_dir_option</a></tt><tt class="py-op">}</tt> </tt>
<a name="L873"></a><tt class="py-lineno">873</tt> <tt class="py-line"><tt id="link-261" class="py-name"><a title="epydoc.markup.restructuredtext.importgraph_directive" class="py-name" href="#" onclick="return doclink('link-261', 'importgraph_directive', 'link-258');">importgraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L874"></a><tt class="py-lineno">874</tt> <tt class="py-line"><tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">register_directive</tt><tt class="py-op">(</tt><tt class="py-string">'importgraph'</tt><tt class="py-op">,</tt> <tt id="link-262" class="py-name"><a title="epydoc.markup.restructuredtext.importgraph_directive" class="py-name" href="#" onclick="return doclink('link-262', 'importgraph_directive', 'link-258');">importgraph_directive</a></tt><tt class="py-op">)</tt> </tt>
<a name="L875"></a><tt class="py-lineno">875</tt> <tt class="py-line"> </tt>
<a name="_construct_importgraph"></a><div id="_construct_importgraph-def"><a name="L876"></a><tt class="py-lineno">876</tt> <a class="py-toggle" href="#" id="_construct_importgraph-toggle" onclick="return toggle('_construct_importgraph');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#_construct_importgraph">_construct_importgraph</a><tt class="py-op">(</tt><tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">,</tt> <tt class="py-param">linker</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_construct_importgraph-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_construct_importgraph-expanded"><a name="L877"></a><tt class="py-lineno">877</tt> <tt class="py-line"> <tt class="py-docstring">"""Graph generator for L{importgraph_directive}"""</tt> </tt>
<a name="L878"></a><tt class="py-lineno">878</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">arguments</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L879"></a><tt class="py-lineno">879</tt> <tt class="py-line"> <tt class="py-name">modules</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-263" class="py-name"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-263', 'find', 'link-229');">find</a></tt><tt class="py-op">(</tt><tt id="link-264" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-264', 'name', 'link-230');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L880"></a><tt class="py-lineno">880</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-265" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-265', 'name', 'link-230');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">arguments</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">','</tt><tt class="py-op">,</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">]</tt> </tt>
<a name="L881"></a><tt class="py-lineno">881</tt> <tt class="py-line"> <tt class="py-name">modules</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">modules</tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-266" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-266', 'ModuleDoc', 'link-9');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L882"></a><tt class="py-lineno">882</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L883"></a><tt class="py-lineno">883</tt> <tt class="py-line"> <tt class="py-name">modules</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-267" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-267', 'ModuleDoc', 'link-9');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L884"></a><tt class="py-lineno">884</tt> <tt class="py-line"> </tt>
<a name="L885"></a><tt class="py-lineno">885</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-268" class="py-name" targets="Function epydoc.docwriter.dotgraph.import_graph()=epydoc.docwriter.dotgraph-module.html#import_graph"><a title="epydoc.docwriter.dotgraph.import_graph" class="py-name" href="#" onclick="return doclink('link-268', 'import_graph', 'link-268');">import_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">modules</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
</div><a name="L886"></a><tt class="py-lineno">886</tt> <tt class="py-line"> </tt>
<a name="callgraph_directive"></a><div id="callgraph_directive-def"><a name="L887"></a><tt class="py-lineno">887</tt> <a class="py-toggle" href="#" id="callgraph_directive-toggle" onclick="return toggle('callgraph_directive');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#callgraph_directive">callgraph_directive</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L888"></a><tt class="py-lineno">888</tt> <tt class="py-line"> <tt class="py-param">content_offset</tt><tt class="py-op">,</tt> <tt class="py-param">block_text</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">,</tt> <tt class="py-param">state_machine</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="callgraph_directive-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="callgraph_directive-expanded"><a name="L889"></a><tt class="py-lineno">889</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt> <tt id="link-269" class="py-name"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-269', 'dotgraph', 'link-13');">dotgraph</a></tt><tt class="py-op">(</tt><tt id="link-270" class="py-name" targets="Function epydoc.markup.restructuredtext._construct_callgraph()=epydoc.markup.restructuredtext-module.html#_construct_callgraph"><a title="epydoc.markup.restructuredtext._construct_callgraph" class="py-name" href="#" onclick="return doclink('link-270', '_construct_callgraph', 'link-270');">_construct_callgraph</a></tt><tt class="py-op">,</tt> <tt class="py-name">arguments</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">)</tt> <tt class="py-op">]</tt> </tt>
</div><a name="L890"></a><tt class="py-lineno">890</tt> <tt class="py-line"><tt id="link-271" class="py-name" targets="Function epydoc.markup.restructuredtext.callgraph_directive()=epydoc.markup.restructuredtext-module.html#callgraph_directive"><a title="epydoc.markup.restructuredtext.callgraph_directive" class="py-name" href="#" onclick="return doclink('link-271', 'callgraph_directive', 'link-271');">callgraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">arguments</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L891"></a><tt class="py-lineno">891</tt> <tt class="py-line"><tt id="link-272" class="py-name"><a title="epydoc.markup.restructuredtext.callgraph_directive" class="py-name" href="#" onclick="return doclink('link-272', 'callgraph_directive', 'link-271');">callgraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">options</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'dir'</tt><tt class="py-op">:</tt> <tt id="link-273" class="py-name"><a title="epydoc.markup.restructuredtext._dir_option" class="py-name" href="#" onclick="return doclink('link-273', '_dir_option', 'link-225');">_dir_option</a></tt><tt class="py-op">,</tt> </tt>
<a name="L892"></a><tt class="py-lineno">892</tt> <tt class="py-line"> <tt class="py-string">'add_callers'</tt><tt class="py-op">:</tt> <tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">flag</tt><tt class="py-op">,</tt> </tt>
<a name="L893"></a><tt class="py-lineno">893</tt> <tt class="py-line"> <tt class="py-string">'add_callees'</tt><tt class="py-op">:</tt> <tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">flag</tt><tt class="py-op">}</tt> </tt>
<a name="L894"></a><tt class="py-lineno">894</tt> <tt class="py-line"><tt id="link-274" class="py-name"><a title="epydoc.markup.restructuredtext.callgraph_directive" class="py-name" href="#" onclick="return doclink('link-274', 'callgraph_directive', 'link-271');">callgraph_directive</a></tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L895"></a><tt class="py-lineno">895</tt> <tt class="py-line"><tt class="py-name">directives</tt><tt class="py-op">.</tt><tt class="py-name">register_directive</tt><tt class="py-op">(</tt><tt class="py-string">'callgraph'</tt><tt class="py-op">,</tt> <tt id="link-275" class="py-name"><a title="epydoc.markup.restructuredtext.callgraph_directive" class="py-name" href="#" onclick="return doclink('link-275', 'callgraph_directive', 'link-271');">callgraph_directive</a></tt><tt class="py-op">)</tt> </tt>
<a name="L896"></a><tt class="py-lineno">896</tt> <tt class="py-line"> </tt>
<a name="_construct_callgraph"></a><div id="_construct_callgraph-def"><a name="L897"></a><tt class="py-lineno">897</tt> <a class="py-toggle" href="#" id="_construct_callgraph-toggle" onclick="return toggle('_construct_callgraph');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.restructuredtext-module.html#_construct_callgraph">_construct_callgraph</a><tt class="py-op">(</tt><tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">,</tt> <tt class="py-param">linker</tt><tt class="py-op">,</tt> <tt class="py-param">arguments</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_construct_callgraph-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_construct_callgraph-expanded"><a name="L898"></a><tt class="py-lineno">898</tt> <tt class="py-line"> <tt class="py-docstring">"""Graph generator for L{callgraph_directive}"""</tt> </tt>
<a name="L899"></a><tt class="py-lineno">899</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">arguments</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L900"></a><tt class="py-lineno">900</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-276" class="py-name"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-276', 'find', 'link-229');">find</a></tt><tt class="py-op">(</tt><tt id="link-277" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-277', 'name', 'link-230');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-278" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-278', 'name', 'link-230');">name</a></tt> <tt class="py-keyword">in</tt> </tt>
<a name="L901"></a><tt class="py-lineno">901</tt> <tt class="py-line"> <tt class="py-name">arguments</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">','</tt><tt class="py-op">,</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L902"></a><tt class="py-lineno">902</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">]</tt> </tt>
<a name="L903"></a><tt class="py-lineno">903</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L904"></a><tt class="py-lineno">904</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">context</tt><tt class="py-op">]</tt> </tt>
<a name="L905"></a><tt class="py-lineno">905</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-279" class="py-name" targets="Function epydoc.docwriter.dotgraph.call_graph()=epydoc.docwriter.dotgraph-module.html#call_graph"><a title="epydoc.docwriter.dotgraph.call_graph" class="py-name" href="#" onclick="return doclink('link-279', 'call_graph', 'link-279');">call_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">docs</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
</div><a name="L906"></a><tt class="py-lineno">906</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<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:09:59 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>
