<?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.docwriter.latex</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.docwriter-module.html">Package docwriter</a> ::
Module latex
</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.docwriter.latex-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.docwriter.latex-module.html">Module epydoc.docwriter.latex</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"># epydoc.py: epydoc LaTeX output generator</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 [01/30/01 05:18 PM]</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: latex.py 1621 2007-09-23 18:54:23Z edloper $</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">The LaTeX output generator for epydoc. The main interface provided by</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">this module is the L{LatexWriter} class.</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">@todo: Inheritance=listed</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</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="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-keyword">import</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 class="py-op">,</tt> <tt class="py-name">sys</tt><tt class="py-op">,</tt> <tt class="py-name">time</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">,</tt> <tt class="py-name">textwrap</tt><tt class="py-op">,</tt> <tt class="py-name">codecs</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-1', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-2', 'apidoc', 'link-2');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-3', 'epydoc', 'link-1');">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>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-5" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-5', 'epydoc', 'link-1');">epydoc</a></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-6" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-6', 'epydoc', 'link-1');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-7" 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-7', 'log', 'link-7');">log</a></tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-8" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-8', 'epydoc', 'link-1');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-9" 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-9', 'markup', 'link-9');">markup</a></tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-10" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-10', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Module epydoc.test.util=epydoc.test.util-module.html,Module epydoc.util=epydoc.util-module.html"><a title="epydoc.test.util
epydoc.util" class="py-name" href="#" onclick="return doclink('link-11', 'util', 'link-11');">util</a></tt> <tt class="py-keyword">import</tt> <tt id="link-12" class="py-name" targets="Function epydoc.util.plaintext_to_latex()=epydoc.util-module.html#plaintext_to_latex"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-12', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-13" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-13', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-14" 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-14', 'markup', 'link-9');">markup</a></tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
<a name="LatexWriter"></a><div id="LatexWriter-def"><a name="L27"></a><tt class="py-lineno"> 27</tt> <a class="py-toggle" href="#" id="LatexWriter-toggle" onclick="return toggle('LatexWriter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html">LatexWriter</a><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="LatexWriter-expanded"><a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"> <tt id="link-15" class="py-name" targets="Variable epydoc.docwriter.latex.LatexWriter.PREAMBLE=epydoc.docwriter.latex.LatexWriter-class.html#PREAMBLE"><a title="epydoc.docwriter.latex.LatexWriter.PREAMBLE" class="py-name" href="#" onclick="return doclink('link-15', 'PREAMBLE', 'link-15');">PREAMBLE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> <tt class="py-string">"\\documentclass{article}"</tt><tt class="py-op">,</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> <tt class="py-string">"\\usepackage{alltt, parskip, fancyhdr, boxedminipage}"</tt><tt class="py-op">,</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"> <tt class="py-string">"\\usepackage{makeidx, multirow, longtable, tocbibind, amssymb}"</tt><tt class="py-op">,</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> <tt class="py-string">"\\usepackage{fullpage}"</tt><tt class="py-op">,</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> <tt class="py-string">"\\usepackage[usenames]{color}"</tt><tt class="py-op">,</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"> <tt class="py-comment"># Fix the heading position -- without this, the headings generated</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> <tt class="py-comment"># by the fancyheadings package sometimes overlap the text.</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> <tt class="py-string">"\\setlength{\\headheight}{16pt}"</tt><tt class="py-op">,</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> <tt class="py-string">"\\setlength{\\headsep}{24pt}"</tt><tt class="py-op">,</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> <tt class="py-string">"\\setlength{\\topmargin}{-\\headsep}"</tt><tt class="py-op">,</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-comment"># By default, do not indent paragraphs.</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-string">"\\setlength{\\parindent}{0ex}"</tt><tt class="py-op">,</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt class="py-string">"\\setlength{\\parskip}{2ex}"</tt><tt class="py-op">,</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> <tt class="py-comment"># Double the standard size boxedminipage outlines.</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt class="py-string">"\\setlength{\\fboxrule}{2\\fboxrule}"</tt><tt class="py-op">,</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> <tt class="py-comment"># Create a 'base class' length named BCL for use in base trees.</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-string">"\\newlength{\\BCL} % base class length, for base trees."</tt><tt class="py-op">,</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-comment"># Display the section & subsection names in a header.</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> <tt class="py-string">"\\pagestyle{fancy}"</tt><tt class="py-op">,</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-string">"\\renewcommand{\\sectionmark}[1]{\\markboth{#1}{}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> <tt class="py-string">"\\renewcommand{\\subsectionmark}[1]{\\markright{#1}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> <tt class="py-comment"># Colorization for python source code</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@keywordcolour}{rgb}{1,0.45882,0}"</tt><tt class="py-op">,</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@stringcolour}{rgb}{0,0.666666,0}"</tt><tt class="py-op">,</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@commentcolour}{rgb}{1,0,0}"</tt><tt class="py-op">,</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@ps1colour}{rgb}{0.60784,0,0}"</tt><tt class="py-op">,</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@ps2colour}{rgb}{0.60784,0,1}"</tt><tt class="py-op">,</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@inputcolour}{rgb}{0,0,0}"</tt><tt class="py-op">,</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@outputcolour}{rgb}{0,0,1}"</tt><tt class="py-op">,</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@exceptcolour}{rgb}{1,0,0}"</tt><tt class="py-op">,</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@defnamecolour}{rgb}{1,0.5,0.5}"</tt><tt class="py-op">,</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@builtincolour}{rgb}{0.58039,0,0.58039}"</tt><tt class="py-op">,</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@identifiercolour}{rgb}{0,0,0}"</tt><tt class="py-op">,</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@linenumcolour}{rgb}{0.4,0.4,0.4}"</tt><tt class="py-op">,</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-string">"\\definecolor{py@inputcolour}{rgb}{0,0,0}"</tt><tt class="py-op">,</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-string">"% Prompt"</tt><tt class="py-op">,</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrcprompt}[1]{\\textcolor{py@ps1colour}"</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrcmore}[1]{\\textcolor{py@ps2colour}"</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-string">"% Source code"</tt><tt class="py-op">,</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrckeyword}[1]{\\textcolor{py@keywordcolour}"</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrcbuiltin}[1]{\\textcolor{py@builtincolour}"</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrcstring}[1]{\\textcolor{py@stringcolour}"</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrcdefname}[1]{\\textcolor{py@defnamecolour}"</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrcother}[1]{\\small\\textbf{#1}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-string">"% Comments"</tt><tt class="py-op">,</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrccomment}[1]{\\textcolor{py@commentcolour}"</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-string">"% Output"</tt><tt class="py-op">,</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrcoutput}[1]{\\textcolor{py@outputcolour}"</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-string">"% Exceptions"</tt><tt class="py-op">,</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-string">"\\newcommand{\\pysrcexcept}[1]{\\textcolor{py@exceptcolour}"</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-string">"{\\small\\textbf{#1}}}"</tt><tt class="py-op">,</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-comment"># Size of the function description boxes.</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-string">"\\newlength{\\funcindent}"</tt><tt class="py-op">,</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-string">"\\newlength{\\funcwidth}"</tt><tt class="py-op">,</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-string">"\\setlength{\\funcindent}{1cm}"</tt><tt class="py-op">,</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-string">"\\setlength{\\funcwidth}{\\textwidth}"</tt><tt class="py-op">,</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-string">"\\addtolength{\\funcwidth}{-2\\funcindent}"</tt><tt class="py-op">,</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-comment"># Size of the var description tables.</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-string">"\\newlength{\\varindent}"</tt><tt class="py-op">,</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-string">"\\newlength{\\varnamewidth}"</tt><tt class="py-op">,</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-string">"\\newlength{\\vardescrwidth}"</tt><tt class="py-op">,</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-string">"\\newlength{\\varwidth}"</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">"\\setlength{\\varindent}{1cm}"</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">"\\setlength{\\varnamewidth}{.3\\textwidth}"</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">"\\setlength{\\varwidth}{\\textwidth}"</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">"\\addtolength{\\varwidth}{-4\\tabcolsep}"</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">"\\addtolength{\\varwidth}{-3\\arrayrulewidth}"</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">"\\addtolength{\\varwidth}{-2\\varindent}"</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">"\\setlength{\\vardescrwidth}{\\varwidth}"</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">"\\addtolength{\\vardescrwidth}{-\\varnamewidth}"</tt><tt class="py-op">,</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> <tt class="py-comment"># Define new environment for displaying parameter lists.</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> <tt class="py-name">textwrap</tt><tt class="py-op">.</tt><tt class="py-name">dedent</tt><tt class="py-op">(</tt><tt class="py-string">"""\</tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"><tt class="py-string"> \\newenvironment{Ventry}[1]%</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"><tt class="py-string"> {\\begin{list}{}{%</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"><tt class="py-string"> \\renewcommand{\\makelabel}[1]{\\texttt{##1:}\\hfil}%</tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt class="py-string"> \\settowidth{\\labelwidth}{\\texttt{#1:}}%</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-string"> \\setlength{\\leftmargin}{\\labelsep}%</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"><tt class="py-string"> \\addtolength{\\leftmargin}{\\labelwidth}}}%</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"><tt class="py-string"> {\\end{list}}"""</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"> </tt>
<a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"> <tt id="link-16" class="py-name" targets="Variable epydoc.docwriter.latex.LatexWriter.HRULE=epydoc.docwriter.latex.LatexWriter-class.html#HRULE"><a title="epydoc.docwriter.latex.LatexWriter.HRULE" class="py-name" href="#" onclick="return doclink('link-16', 'HRULE', 'link-16');">HRULE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\\rule{\\textwidth}{0.5\\fboxrule}\n\n'</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"> <tt id="link-17" class="py-name" targets="Variable epydoc.docwriter.latex.LatexWriter.SECTIONS=epydoc.docwriter.latex.LatexWriter-class.html#SECTIONS"><a title="epydoc.docwriter.latex.LatexWriter.SECTIONS" class="py-name" href="#" onclick="return doclink('link-17', 'SECTIONS', 'link-17');">SECTIONS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'\\part{%s}'</tt><tt class="py-op">,</tt> <tt class="py-string">'\\chapter{%s}'</tt><tt class="py-op">,</tt> <tt class="py-string">'\\section{%s}'</tt><tt class="py-op">,</tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"> <tt class="py-string">'\\subsection{%s}'</tt><tt class="py-op">,</tt> <tt class="py-string">'\\subsubsection{%s}'</tt><tt class="py-op">,</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"> <tt class="py-string">'\\textbf{%s}'</tt><tt class="py-op">]</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> <tt id="link-18" class="py-name" targets="Variable epydoc.docwriter.latex.LatexWriter.STAR_SECTIONS=epydoc.docwriter.latex.LatexWriter-class.html#STAR_SECTIONS"><a title="epydoc.docwriter.latex.LatexWriter.STAR_SECTIONS" class="py-name" href="#" onclick="return doclink('link-18', 'STAR_SECTIONS', 'link-18');">STAR_SECTIONS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'\\part*{%s}'</tt><tt class="py-op">,</tt> <tt class="py-string">'\\chapter*{%s}'</tt><tt class="py-op">,</tt> <tt class="py-string">'\\section*{%s}'</tt><tt class="py-op">,</tt> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"> <tt class="py-string">'\\subsection*{%s}'</tt><tt class="py-op">,</tt> <tt class="py-string">'\\subsubsection*{%s}'</tt><tt class="py-op">,</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"> <tt class="py-string">'\\textbf{%s}'</tt><tt class="py-op">]</tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.__init__"></a><div id="LatexWriter.__init__-def"><a name="L128"></a><tt class="py-lineno"> 128</tt> <a class="py-toggle" href="#" id="LatexWriter.__init__-toggle" onclick="return toggle('LatexWriter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-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">docindex</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>
</div><div id="LatexWriter.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.__init__-expanded"><a name="L129"></a><tt class="py-lineno"> 129</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="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"> <tt class="py-comment"># Process keyword arguments</tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</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">_show_private</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'private'</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'prj_name'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'API Documentation'</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_crossref</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'crossref'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_index</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'index'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_list_classes_separately</tt><tt class="py-op">=</tt><tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'list_classes_separately'</tt><tt class="py-op">,</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'inheritance'</tt><tt class="py-op">,</tt> <tt class="py-string">'listed'</tt><tt class="py-op">)</tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exclude</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'exclude'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_top_section</tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_index_functions</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_hyperref</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> <tt class="py-comment">#: The Python representation of the encoding.</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: Update L{latex_encodings} in case of mismatch between it and</tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: the C{inputenc} LaTeX package.</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</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 class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'encoding'</tt><tt class="py-op">,</tt> <tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">valdocs</tt> <tt class="py-op">=</tt> <tt class="py-name">valdocs</tt> <tt class="py-op">=</tt> <tt id="link-19" class="py-name" targets="Function epydoc.compat.sorted()=epydoc.compat-module.html#sorted"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-19', 'sorted', 'link-19');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name" targets="Method epydoc.apidoc.DocIndex.reachable_valdocs()=epydoc.apidoc.DocIndex-class.html#reachable_valdocs,Function epydoc.apidoc.reachable_valdocs()=epydoc.apidoc-module.html#reachable_valdocs"><a title="epydoc.apidoc.DocIndex.reachable_valdocs
epydoc.apidoc.reachable_valdocs" class="py-name" href="#" onclick="return doclink('link-20', 'reachable_valdocs', 'link-20');">reachable_valdocs</a></tt><tt class="py-op">(</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"> <tt id="link-21" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.imports=epydoc.apidoc.ModuleDoc-class.html#imports"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-21', 'imports', 'link-21');">imports</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">packages</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-22" 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-22', 'bases', 'link-22');">bases</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-23" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodules=epydoc.apidoc.ModuleDoc-class.html#submodules"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-23', 'submodules', 'link-23');">submodules</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"> <tt id="link-24" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.subclasses=epydoc.apidoc.ClassDoc-class.html#subclasses"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-24', 'subclasses', 'link-24');">subclasses</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">private</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.num_files()=epydoc.docwriter.latex.LatexWriter-class.html#num_files"><a title="epydoc.docwriter.latex.LatexWriter.num_files" class="py-name" href="#" onclick="return doclink('link-25', 'num_files', 'link-25');">num_files</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"> <tt class="py-comment"># For use with select_variables():</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</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 class="py-name">_show_private</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</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">valdocs</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-26" 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-26', 'ClassDoc', 'link-26');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"> <tt class="py-string">"""The list of L{ClassDoc}s for the documented classes."""</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">)</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"> <tt class="py-string">"""The set of L{ClassDoc}s for the documented classes."""</tt> </tt>
</div><a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write"></a><div id="LatexWriter.write-def"><a name="L160"></a><tt class="py-lineno"> 160</tt> <a class="py-toggle" href="#" id="LatexWriter.write-toggle" onclick="return toggle('LatexWriter.write');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write">write</a><tt class="py-op">(</tt><tt class="py-param">self</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 class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write-expanded"><a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-docstring"> Write the API documentation for the entire project to the</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"><tt class="py-docstring"> given directory.</tt> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"><tt class="py-docstring"> @type directory: C{string}</tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"><tt class="py-docstring"> @param directory: The directory to which output should be</tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-docstring"> written. If no directory is specified, output will be</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-docstring"> written to the current directory. If the directory does</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-docstring"> not exist, it will be created.</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"><tt class="py-docstring"> @raise OSError: If C{directory} cannot be created,</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"><tt class="py-docstring"> @raise OSError: If any file cannot be created or written to.</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"> <tt class="py-comment"># For progress reporting:</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</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">_files_written</tt> <tt class="py-op">=</tt> <tt class="py-number">0.</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"> <tt class="py-comment"># Set the default values for ValueDoc formatted representations.</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">orig_valdoc_defaults</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-27" class="py-name" targets="Class epydoc.apidoc.ValueDoc=epydoc.apidoc.ValueDoc-class.html"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-27', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-28" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN=epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-28', 'SUMMARY_REPR_LINELEN', 'link-28');">SUMMARY_REPR_LINELEN</a></tt><tt class="py-op">,</tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"> <tt id="link-29" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-29', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.REPR_LINELEN=epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN"><a title="epydoc.apidoc.ValueDoc.REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-30', 'REPR_LINELEN', 'link-30');">REPR_LINELEN</a></tt><tt class="py-op">,</tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"> <tt id="link-31" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-31', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.REPR_MAXLINES=epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES"><a title="epydoc.apidoc.ValueDoc.REPR_MAXLINES" class="py-name" href="#" onclick="return doclink('link-32', 'REPR_MAXLINES', 'link-32');">REPR_MAXLINES</a></tt><tt class="py-op">)</tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"> <tt id="link-33" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-33', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-34', 'SUMMARY_REPR_LINELEN', 'link-28');">SUMMARY_REPR_LINELEN</a></tt> <tt class="py-op">=</tt> <tt class="py-number">60</tt> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"> <tt id="link-35" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-35', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-36', 'REPR_LINELEN', 'link-30');">REPR_LINELEN</a></tt> <tt class="py-op">=</tt> <tt class="py-number">52</tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"> <tt id="link-37" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-37', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_MAXLINES" class="py-name" href="#" onclick="return doclink('link-38', 'REPR_MAXLINES', 'link-32');">REPR_MAXLINES</a></tt> <tt class="py-op">=</tt> <tt class="py-number">5</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"> <tt class="py-comment"># Create destination directories, if necessary</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">directory</tt><tt class="py-op">:</tt> <tt class="py-name">directory</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">curdir</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._mkdir()=epydoc.docwriter.html.HTMLWriter-class.html#_mkdir,Method epydoc.docwriter.latex.LatexWriter._mkdir()=epydoc.docwriter.latex.LatexWriter-class.html#_mkdir"><a title="epydoc.docwriter.html.HTMLWriter._mkdir
epydoc.docwriter.latex.LatexWriter._mkdir" class="py-name" href="#" onclick="return doclink('link-39', '_mkdir', 'link-39');">_mkdir</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</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="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"> <tt class="py-comment"># Write the top-level file.</tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._write()=epydoc.docwriter.html.HTMLWriter-class.html#_write,Method epydoc.docwriter.latex.LatexWriter._write()=epydoc.docwriter.latex.LatexWriter-class.html#_write"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-40', '_write', 'link-40');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_topfile()=epydoc.docwriter.latex.LatexWriter-class.html#write_topfile"><a title="epydoc.docwriter.latex.LatexWriter.write_topfile" class="py-name" href="#" onclick="return doclink('link-41', 'write_topfile', 'link-41');">write_topfile</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'api.tex'</tt><tt class="py-op">)</tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"> <tt class="py-comment"># Write the module & class files.</tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">valdocs</tt><tt class="py-op">:</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</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">val_doc</tt><tt class="py-op">,</tt> <tt id="link-42" 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-42', 'ModuleDoc', 'link-42');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"> <tt id="link-43" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.filename=epydoc.apidoc.ModuleDoc-class.html#filename"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-43', 'filename', 'link-43');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%s-module.tex'</tt> <tt class="py-op">%</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name" targets="Variable epydoc.apidoc.GenericValueDoc.canonical_name=epydoc.apidoc.GenericValueDoc-class.html#canonical_name,Variable epydoc.apidoc.ValueDoc.canonical_name=epydoc.apidoc.ValueDoc-class.html#canonical_name,Variable epydoc.apidoc.VariableDoc.canonical_name=epydoc.apidoc.VariableDoc-class.html#canonical_name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-44', 'canonical_name', 'link-44');">canonical_name</a></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 id="link-45" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-45', '_write', 'link-40');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_module()=epydoc.docwriter.html.HTMLWriter-class.html#write_module,Method epydoc.docwriter.latex.LatexWriter.write_module()=epydoc.docwriter.latex.LatexWriter-class.html#write_module,Method epydoc.docwriter.plaintext.PlaintextWriter.write_module()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#write_module"><a title="epydoc.docwriter.html.HTMLWriter.write_module
epydoc.docwriter.latex.LatexWriter.write_module
epydoc.docwriter.plaintext.PlaintextWriter.write_module" class="py-name" href="#" onclick="return doclink('link-46', 'write_module', 'link-46');">write_module</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-47" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-47', 'filename', 'link-43');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</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">elif</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-48" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-48', 'ClassDoc', 'link-26');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_list_classes_separately</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"> <tt id="link-49" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-49', 'filename', 'link-43');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%s-class.tex'</tt> <tt class="py-op">%</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-50', 'canonical_name', 'link-44');">canonical_name</a></tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-51', '_write', 'link-40');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_class()=epydoc.docwriter.html.HTMLWriter-class.html#write_class,Method epydoc.docwriter.latex.LatexWriter.write_class()=epydoc.docwriter.latex.LatexWriter-class.html#write_class,Method epydoc.docwriter.plaintext.PlaintextWriter.write_class()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#write_class"><a title="epydoc.docwriter.html.HTMLWriter.write_class
epydoc.docwriter.latex.LatexWriter.write_class
epydoc.docwriter.plaintext.PlaintextWriter.write_class" class="py-name" href="#" onclick="return doclink('link-52', 'write_class', 'link-52');">write_class</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-53" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-53', 'filename', 'link-43');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"> <tt class="py-comment"># Restore defaults that we changed.</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-op">(</tt><tt id="link-54" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-54', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-55', 'SUMMARY_REPR_LINELEN', 'link-28');">SUMMARY_REPR_LINELEN</a></tt><tt class="py-op">,</tt> <tt id="link-56" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-56', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-57', 'REPR_LINELEN', 'link-30');">REPR_LINELEN</a></tt><tt class="py-op">,</tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> <tt id="link-58" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-58', 'ValueDoc', 'link-27');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_MAXLINES" class="py-name" href="#" onclick="return doclink('link-59', 'REPR_MAXLINES', 'link-32');">REPR_MAXLINES</a></tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">orig_valdoc_defaults</tt> </tt>
</div><a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> </tt>
<a name="LatexWriter._write"></a><div id="LatexWriter._write-def"><a name="L207"></a><tt class="py-lineno"> 207</tt> <a class="py-toggle" href="#" id="LatexWriter._write-toggle" onclick="return toggle('LatexWriter._write');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#_write">_write</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">write_func</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">,</tt> <tt class="py-param">filename</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>
</div><div id="LatexWriter._write-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter._write-expanded"><a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt class="py-comment"># Display our progress.</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</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">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> <tt id="link-60" 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-60', 'log', 'link-7');">log</a></tt><tt class="py-op">.</tt><tt id="link-61" class="py-name" targets="Method epydoc.cli.ConsoleLogger.progress()=epydoc.cli.ConsoleLogger-class.html#progress,Method epydoc.cli.UnifiedProgressConsoleLogger.progress()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#progress,Method epydoc.docbuilder._ProgressEstimator.progress()=epydoc.docbuilder._ProgressEstimator-class.html#progress,Method epydoc.gui.GUILogger.progress()=epydoc.gui.GUILogger-class.html#progress,Method epydoc.log.Logger.progress()=epydoc.log.Logger-class.html#progress,Function epydoc.log.progress()=epydoc.log-module.html#progress"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-61', 'progress', 'link-61');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt><tt class="py-op">/</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt><tt class="py-op">,</tt> <tt id="link-62" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-62', 'filename', 'link-43');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt id="link-63" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-63', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-64', '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">directory</tt><tt class="py-op">,</tt> <tt id="link-65" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-65', 'filename', 'link-43');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</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">_encoding</tt> <tt class="py-op">==</tt> <tt class="py-string">'utf-8'</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">f</tt> <tt class="py-op">=</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name" targets="Method epydoc.gui.EpydocGUI.open()=epydoc.gui.EpydocGUI-class.html#open"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-66', 'open', 'link-66');">open</a></tt><tt class="py-op">(</tt><tt id="link-67" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-67', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">,</tt> <tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> <tt class="py-name">write_func</tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name" targets="Method epydoc.docintrospecter._DevNull.write()=epydoc.docintrospecter._DevNull-class.html#write,Method epydoc.docwriter.dotgraph.DotGraph.write()=epydoc.docwriter.dotgraph.DotGraph-class.html#write,Method epydoc.docwriter.html.HTMLWriter.write()=epydoc.docwriter.html.HTMLWriter-class.html#write,Method epydoc.docwriter.latex.LatexWriter.write()=epydoc.docwriter.latex.LatexWriter-class.html#write,Method epydoc.docwriter.plaintext.PlaintextWriter.write()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#write"><a title="epydoc.docintrospecter._DevNull.write
epydoc.docwriter.dotgraph.DotGraph.write
epydoc.docwriter.html.HTMLWriter.write
epydoc.docwriter.latex.LatexWriter.write
epydoc.docwriter.plaintext.PlaintextWriter.write" class="py-name" href="#" onclick="return doclink('link-68', 'write', 'link-68');">write</a></tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name" targets="Method epydoc.cli.HTMLLogger.close()=epydoc.cli.HTMLLogger-class.html#close,Method epydoc.docintrospecter._DevNull.close()=epydoc.docintrospecter._DevNull-class.html#close,Method epydoc.log.Logger.close()=epydoc.log.Logger-class.html#close,Function epydoc.log.close()=epydoc.log-module.html#close"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-69', 'close', 'link-69');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> <tt class="py-name">write_func</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">u''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">s</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>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">UnicodeError</tt><tt class="py-op">:</tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt id="link-70" 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-70', 'log', 'link-7');">log</a></tt><tt class="py-op">.</tt><tt id="link-71" 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-71', 'error', 'link-71');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">"Output could not be represented with the "</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> <tt class="py-string">"given encoding (%r). Unencodable characters "</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> <tt class="py-string">"will be displayed as '?'. It is recommended "</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"> <tt class="py-string">"that you use a different output encoding (utf-8, "</tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> <tt class="py-string">"if it's supported by latex on your system)."</tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> <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>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">s</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-string">'replace'</tt><tt class="py-op">)</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt id="link-72" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-72', 'open', 'link-66');">open</a></tt><tt class="py-op">(</tt><tt id="link-73" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-73', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">)</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="epydoc.docintrospecter._DevNull.write
epydoc.docwriter.dotgraph.DotGraph.write
epydoc.docwriter.html.HTMLWriter.write
epydoc.docwriter.latex.LatexWriter.write
epydoc.docwriter.plaintext.PlaintextWriter.write" class="py-name" href="#" onclick="return doclink('link-74', 'write', 'link-68');">write</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-75', 'close', 'link-69');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.num_files"></a><div id="LatexWriter.num_files-def"><a name="L235"></a><tt class="py-lineno"> 235</tt> <a class="py-toggle" href="#" id="LatexWriter.num_files-toggle" onclick="return toggle('LatexWriter.num_files');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#num_files">num_files</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="LatexWriter.num_files-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.num_files-expanded"><a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"> @return: The number of files that this C{LatexFormatter} will</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"> generate.</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{int}</tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</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="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">valdocs</tt><tt class="py-op">:</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</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">doc</tt><tt class="py-op">,</tt> <tt id="link-76" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-76', 'ModuleDoc', 'link-42');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">n</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</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">doc</tt><tt class="py-op">,</tt> <tt id="link-77" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-77', 'ClassDoc', 'link-26');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_list_classes_separately</tt><tt class="py-op">:</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</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="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">n</tt> </tt>
</div><a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> </tt>
<a name="LatexWriter._mkdir"></a><div id="LatexWriter._mkdir-def"><a name="L248"></a><tt class="py-lineno"> 248</tt> <a class="py-toggle" href="#" id="LatexWriter._mkdir-toggle" onclick="return toggle('LatexWriter._mkdir');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#_mkdir">_mkdir</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter._mkdir-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter._mkdir-expanded"><a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"><tt class="py-docstring"> If the given directory does not exist, then attempt to create it.</tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-78', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">isdir</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-79', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">OSError</tt><tt class="py-op">(</tt><tt class="py-string">'%r is not a directory'</tt> <tt class="py-op">%</tt> <tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">mkdir</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
</div><a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Main Doc File</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="LatexWriter.write_topfile"></a><div id="LatexWriter.write_topfile-def"><a name="L262"></a><tt class="py-lineno"> 262</tt> <a class="py-toggle" href="#" id="LatexWriter.write_topfile-toggle" onclick="return toggle('LatexWriter.write_topfile');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_topfile">write_topfile</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_topfile-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_topfile-expanded"><a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_header()=epydoc.docwriter.html.HTMLWriter-class.html#write_header,Method epydoc.docwriter.latex.LatexWriter.write_header()=epydoc.docwriter.latex.LatexWriter-class.html#write_header"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-80', 'write_header', 'link-80');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Include File'</tt><tt class="py-op">)</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_preamble()=epydoc.docwriter.latex.LatexWriter-class.html#write_preamble"><a title="epydoc.docwriter.latex.LatexWriter.write_preamble" class="py-name" href="#" onclick="return doclink('link-81', 'write_preamble', 'link-81');">write_preamble</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n\\begin{document}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_start_of()=epydoc.docwriter.latex.LatexWriter-class.html#write_start_of"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-82', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Header'</tt><tt class="py-op">)</tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"> <tt class="py-comment"># Write the title.</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-83', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Title'</tt><tt class="py-op">)</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\title{%s}\n'</tt> <tt class="py-op">%</tt> <tt id="link-84" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-84', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</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="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\author{API Documentation}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\maketitle\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"> <tt class="py-comment"># Add a table of contents.</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-85', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Table of Contents'</tt><tt class="py-op">)</tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\addtolength{\\parskip}{-2ex}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\tableofcontents\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\addtolength{\\parskip}{2ex}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt class="py-comment"># Include documentation files.</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-86" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-86', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Includes'</tt><tt class="py-op">)</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">valdocs</tt><tt class="py-op">:</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</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">val_doc</tt><tt class="py-op">,</tt> <tt id="link-87" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-87', 'ModuleDoc', 'link-42');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\include{%s-module}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-88', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> <tt class="py-comment"># If we're listing classes separately, put them after all the</tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># modules.</tt> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</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 class="py-name">_list_classes_separately</tt><tt class="py-op">:</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">valdocs</tt><tt class="py-op">:</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</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">val_doc</tt><tt class="py-op">,</tt> <tt id="link-89" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-89', 'ClassDoc', 'link-26');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\include{%s-class}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-90', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> <tt class="py-comment"># Add the index, if requested.</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</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 class="py-name">_index</tt><tt class="py-op">:</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-91', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Index'</tt><tt class="py-op">)</tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\printindex\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"> <tt class="py-comment"># Add the footer.</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-92" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-92', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Footer'</tt><tt class="py-op">)</tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\end{document}\n\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_preamble"></a><div id="LatexWriter.write_preamble-def"><a name="L302"></a><tt class="py-lineno"> 302</tt> <a class="py-toggle" href="#" id="LatexWriter.write_preamble-toggle" onclick="return toggle('LatexWriter.write_preamble');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_preamble">write_preamble</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_preamble-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_preamble-expanded"><a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"> <tt class="py-name">out</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">self</tt><tt class="py-op">.</tt><tt id="link-93" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.PREAMBLE" class="py-name" href="#" onclick="return doclink('link-93', 'PREAMBLE', 'link-15');">PREAMBLE</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"> <tt class="py-comment"># Set the encoding.</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\usepackage[%s]{inputenc}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-94" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.get_latex_encoding()=epydoc.docwriter.latex.LatexWriter-class.html#get_latex_encoding"><a title="epydoc.docwriter.latex.LatexWriter.get_latex_encoding" class="py-name" href="#" onclick="return doclink('link-94', 'get_latex_encoding', 'link-94');">get_latex_encoding</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> <tt class="py-comment"># If we're generating hyperrefs, add the appropriate packages.</tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</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 class="py-name">_hyperref</tt><tt class="py-op">:</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\definecolor{UrlColor}{rgb}{0,0.08,0.45}\n'</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">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\usepackage[dvips, pagebackref, pdftitle={%s}, '</tt> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"> <tt class="py-string">'pdfcreator={epydoc %s}, bookmarks=true, '</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"> <tt class="py-string">'bookmarksopen=false, pdfpagemode=UseOutlines, '</tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> <tt class="py-string">'colorlinks=true, linkcolor=black, anchorcolor=black, '</tt> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"> <tt class="py-string">'citecolor=black, filecolor=black, menucolor=black, '</tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt class="py-string">'pagecolor=black, urlcolor=UrlColor]{hyperref}\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt> <tt class="py-keyword">or</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt id="link-95" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-95', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-96" class="py-name" targets="Variable epydoc.__version__=epydoc-module.html#__version__"><a title="epydoc.__version__" class="py-name" href="#" onclick="return doclink('link-96', '__version__', 'link-96');">__version__</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> <tt class="py-comment"># If we're generating an index, add it to the preamble.</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</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 class="py-name">_index</tt><tt class="py-op">:</tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">"\\makeindex\n"</tt><tt class="py-op">)</tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> <tt class="py-comment"># If restructuredtext was used, then we need to extend</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the prefix to include LatexTranslator.head_prefix.</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-string">'restructuredtext'</tt> <tt class="py-keyword">in</tt> <tt id="link-97" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-97', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-98" 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-98', 'markup', 'link-9');">markup</a></tt><tt class="py-op">.</tt><tt id="link-99" class="py-name" targets="Variable epydoc.markup.MARKUP_LANGUAGES_USED=epydoc.markup-module.html#MARKUP_LANGUAGES_USED"><a title="epydoc.markup.MARKUP_LANGUAGES_USED" class="py-name" href="#" onclick="return doclink('link-99', 'MARKUP_LANGUAGES_USED', 'link-99');">MARKUP_LANGUAGES_USED</a></tt><tt class="py-op">:</tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-100" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-100', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-101" 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-101', 'markup', 'link-9');">markup</a></tt> <tt class="py-keyword">import</tt> <tt id="link-102" class="py-name" targets="Module epydoc.markup.restructuredtext=epydoc.markup.restructuredtext-module.html"><a title="epydoc.markup.restructuredtext" class="py-name" href="#" onclick="return doclink('link-102', 'restructuredtext', 'link-102');">restructuredtext</a></tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"> <tt class="py-name">rst_head</tt> <tt class="py-op">=</tt> <tt id="link-103" class="py-name"><a title="epydoc.markup.restructuredtext" class="py-name" href="#" onclick="return doclink('link-103', 'restructuredtext', 'link-102');">restructuredtext</a></tt><tt class="py-op">.</tt><tt id="link-104" class="py-name" targets="Function epydoc.markup.restructuredtext.latex_head_prefix()=epydoc.markup.restructuredtext-module.html#latex_head_prefix"><a title="epydoc.markup.restructuredtext.latex_head_prefix" class="py-name" href="#" onclick="return doclink('link-104', 'latex_head_prefix', 'link-104');">latex_head_prefix</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt class="py-name">rst_head</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-name">rst_head</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-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">rst_head</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="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-name">m</tt> <tt class="py-op">=</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'\\usepackage(\[.*?\])?{(.*?)}'</tt><tt class="py-op">,</tt> <tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">m</tt> <tt class="py-keyword">and</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">2</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt class="py-string">'babel'</tt><tt class="py-op">,</tt> <tt class="py-string">'hyperref'</tt><tt class="py-op">,</tt> <tt class="py-string">'color'</tt><tt class="py-op">,</tt> <tt class="py-string">'alltt'</tt><tt class="py-op">,</tt> <tt class="py-string">'parskip'</tt><tt class="py-op">,</tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"> <tt class="py-string">'fancyhdr'</tt><tt class="py-op">,</tt> <tt class="py-string">'boxedminipage'</tt><tt class="py-op">,</tt> <tt class="py-string">'makeidx'</tt><tt class="py-op">,</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> <tt class="py-string">'multirow'</tt><tt class="py-op">,</tt> <tt class="py-string">'longtable'</tt><tt class="py-op">,</tt> <tt class="py-string">'tocbind'</tt><tt class="py-op">,</tt> <tt class="py-string">'assymb'</tt><tt class="py-op">,</tt> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> <tt class="py-string">'fullpage'</tt><tt class="py-op">,</tt> <tt class="py-string">'inputenc'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Chapters</tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="LatexWriter.write_module"></a><div id="LatexWriter.write_module-def"><a name="L346"></a><tt class="py-lineno"> 346</tt> <a class="py-toggle" href="#" id="LatexWriter.write_module-toggle" onclick="return toggle('LatexWriter.write_module');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_module">write_module</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_module-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_module-expanded"><a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-105', 'write_header', 'link-80');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-106" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-106', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Module Description'</tt><tt class="py-op">)</tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-comment"># Add this module to the index.</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-107" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.indexterm()=epydoc.docwriter.latex.LatexWriter-class.html#indexterm"><a title="epydoc.docwriter.latex.LatexWriter.indexterm" class="py-name" href="#" onclick="return doclink('link-107', 'indexterm', 'link-107');">indexterm</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'start'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-comment"># Add a section marker.</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-108" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.section()=epydoc.docwriter.latex.LatexWriter-class.html#section,Method epydoc.docwriter.plaintext.PlaintextWriter.section()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#section"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-108', 'section', 'link-108');">section</a></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">self</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.doc_kind()=epydoc.docwriter.html.HTMLWriter-class.html#doc_kind,Method epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind()=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#doc_kind,Method epydoc.docwriter.latex.LatexWriter.doc_kind()=epydoc.docwriter.latex.LatexWriter-class.html#doc_kind"><a title="epydoc.docwriter.html.HTMLWriter.doc_kind
epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind
epydoc.docwriter.latex.LatexWriter.doc_kind" class="py-name" href="#" onclick="return doclink('link-109', 'doc_kind', 'link-109');">doc_kind</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-110" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-110', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> <tt class="py-comment"># Label our current location.</tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\label{%s}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-111" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.label()=epydoc.docwriter.latex.LatexWriter-class.html#label"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-111', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</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>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> <tt class="py-comment"># Add the module's description.</tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-112" class="py-name" targets="Variable epydoc.apidoc.APIDoc.descr=epydoc.apidoc.APIDoc-class.html#descr,Variable epydoc.cli.descr=epydoc.cli-module.html#descr,Method epydoc.docwriter.html.HTMLWriter.descr()=epydoc.docwriter.html.HTMLWriter-class.html#descr,Method epydoc.markup.ParseError.descr()=epydoc.markup.ParseError-class.html#descr,Method epydoc.markup.epytext.ColorizingError.descr()=epydoc.markup.epytext.ColorizingError-class.html#descr"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-112', 'descr', 'link-112');">descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-113" class="py-name" targets="Variable epydoc.apidoc.UNKNOWN=epydoc.apidoc-module.html#UNKNOWN"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-113', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-114" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.docstring_to_latex()=epydoc.docwriter.latex.LatexWriter-class.html#docstring_to_latex"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-114', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-115" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-115', 'descr', 'link-112');">descr</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt class="py-comment"># Add version, author, warnings, requirements, notes, etc.</tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_standard_fields()=epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields,Method epydoc.docwriter.latex.LatexWriter.write_standard_fields()=epydoc.docwriter.latex.LatexWriter-class.html#write_standard_fields"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_fields
epydoc.docwriter.latex.LatexWriter.write_standard_fields" class="py-name" href="#" onclick="return doclink('link-116', 'write_standard_fields', 'link-116');">write_standard_fields</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"> <tt class="py-comment"># If it's a package, list the sub-modules.</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-117" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-117', 'submodules', 'link-23');">submodules</a></tt> <tt class="py-op">!=</tt> <tt id="link-118" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-118', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-119', 'submodules', 'link-23');">submodules</a></tt><tt class="py-op">:</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_module_list()=epydoc.docwriter.html.HTMLWriter-class.html#write_module_list,Method epydoc.docwriter.latex.LatexWriter.write_module_list()=epydoc.docwriter.latex.LatexWriter-class.html#write_module_list"><a title="epydoc.docwriter.html.HTMLWriter.write_module_list
epydoc.docwriter.latex.LatexWriter.write_module_list" class="py-name" href="#" onclick="return doclink('link-120', 'write_module_list', 'link-120');">write_module_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"> <tt class="py-comment"># Contents.</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</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 class="py-name">_list_classes_separately</tt><tt class="py-op">:</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-121" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_class_list()=epydoc.docwriter.latex.LatexWriter-class.html#write_class_list"><a title="epydoc.docwriter.latex.LatexWriter.write_class_list" class="py-name" href="#" onclick="return doclink('link-121', 'write_class_list', 'link-121');">write_class_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</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.docwriter.latex.LatexWriter.write_func_list()=epydoc.docwriter.latex.LatexWriter-class.html#write_func_list"><a title="epydoc.docwriter.latex.LatexWriter.write_func_list" class="py-name" href="#" onclick="return doclink('link-122', 'write_func_list', 'link-122');">write_func_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Functions'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'function'</tt><tt class="py-op">)</tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-123" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_var_list()=epydoc.docwriter.html.HTMLWriter-class.html#write_var_list,Method epydoc.docwriter.latex.LatexWriter.write_var_list()=epydoc.docwriter.latex.LatexWriter-class.html#write_var_list"><a title="epydoc.docwriter.html.HTMLWriter.write_var_list
epydoc.docwriter.latex.LatexWriter.write_var_list" class="py-name" href="#" onclick="return doclink('link-123', 'write_var_list', 'link-123');">write_var_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Variables'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'other'</tt><tt class="py-op">)</tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"> <tt class="py-comment"># Class list.</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_list_classes_separately</tt><tt class="py-op">:</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"> <tt class="py-name">classes</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name" targets="Method epydoc.apidoc.ClassDoc.select_variables()=epydoc.apidoc.ClassDoc-class.html#select_variables,Method epydoc.apidoc.ModuleDoc.select_variables()=epydoc.apidoc.ModuleDoc-class.html#select_variables"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-124', 'select_variables', 'link-124');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-string">'class'</tt><tt class="py-op">,</tt> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">classes</tt><tt class="py-op">:</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_class
epydoc.docwriter.latex.LatexWriter.write_class
epydoc.docwriter.plaintext.PlaintextWriter.write_class" class="py-name" href="#" onclick="return doclink('link-125', 'write_class', 'link-52');">write_class</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.value=epydoc.apidoc.VariableDoc-class.html#value"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-126', 'value', 'link-126');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"> <tt class="py-comment"># Mark the end of the module (for the index)</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.indexterm" class="py-name" href="#" onclick="return doclink('link-127', 'indexterm', 'link-107');">indexterm</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'end'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_class"></a><div id="LatexWriter.write_class-def"><a name="L387"></a><tt class="py-lineno"> 387</tt> <a class="py-toggle" href="#" id="LatexWriter.write_class-toggle" onclick="return toggle('LatexWriter.write_class');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_class">write_class</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_class-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_class-expanded"><a name="L388"></a><tt class="py-lineno"> 388</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">_list_classes_separately</tt><tt class="py-op">:</tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-128', 'write_header', 'link-80');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<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 id="link-129" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-129', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Class Description'</tt><tt class="py-op">)</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-comment"># Add this class to the index.</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.indexterm" class="py-name" href="#" onclick="return doclink('link-130', 'indexterm', 'link-107');">indexterm</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'start'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> <tt class="py-comment"># Add a section marker.</tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</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 class="py-name">_list_classes_separately</tt><tt class="py-op">:</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"> <tt class="py-name">seclevel</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-131', 'section', 'link-108');">section</a></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">self</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.doc_kind
epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind
epydoc.docwriter.latex.LatexWriter.doc_kind" class="py-name" href="#" onclick="return doclink('link-132', 'doc_kind', 'link-109');">doc_kind</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-133" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-133', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">)</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>
<a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt class="py-name">seclevel</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-134', 'section', 'link-108');">section</a></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">self</tt><tt class="py-op">.</tt><tt id="link-135" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.doc_kind
epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind
epydoc.docwriter.latex.LatexWriter.doc_kind" class="py-name" href="#" onclick="return doclink('link-135', 'doc_kind', 'link-109');">doc_kind</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-136', 'canonical_name', 'link-44');">canonical_name</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 class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> <tt class="py-comment"># Label our current location.</tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\label{%s}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-137', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> <tt class="py-comment"># Add our base list.</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-138" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-138', 'bases', 'link-22');">bases</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-139" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-139', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-140" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-140', 'bases', 'link-22');">bases</a></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="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.base_tree()=epydoc.docwriter.html.HTMLWriter-class.html#base_tree,Method epydoc.docwriter.latex.LatexWriter.base_tree()=epydoc.docwriter.latex.LatexWriter-class.html#base_tree"><a title="epydoc.docwriter.html.HTMLWriter.base_tree
epydoc.docwriter.latex.LatexWriter.base_tree" class="py-name" href="#" onclick="return doclink('link-141', 'base_tree', 'link-141');">base_tree</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"> <tt class="py-comment"># The class's known subclasses</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-142" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-142', 'subclasses', 'link-24');">subclasses</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-143" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-143', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-144" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-144', 'subclasses', 'link-24');">subclasses</a></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="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> <tt class="py-name">sc_items</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-145" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-145', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">sc</tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-146', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">sc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-147" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-147', 'subclasses', 'link-24');">subclasses</a></tt><tt class="py-op">]</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-148" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter._descrlist()=epydoc.docwriter.latex.LatexWriter-class.html#_descrlist"><a title="epydoc.docwriter.latex.LatexWriter._descrlist" class="py-name" href="#" onclick="return doclink('link-148', '_descrlist', 'link-148');">_descrlist</a></tt><tt class="py-op">(</tt><tt class="py-name">sc_items</tt><tt class="py-op">,</tt> <tt class="py-string">'Known Subclasses'</tt><tt class="py-op">,</tt> <tt class="py-name">short</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="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> <tt class="py-comment"># The class's description.</tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-149', 'descr', 'link-112');">descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-150" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-150', 'UNKNOWN', 'link-113');">UNKNOWN</a></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">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-151" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-151', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-152', 'descr', 'link-112');">descr</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"> <tt class="py-comment"># Version, author, warnings, requirements, notes, etc.</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_fields
epydoc.docwriter.latex.LatexWriter.write_standard_fields" class="py-name" href="#" onclick="return doclink('link-153', 'write_standard_fields', 'link-116');">write_standard_fields</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"> <tt class="py-comment"># Contents.</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-154" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_func_list" class="py-name" href="#" onclick="return doclink('link-154', 'write_func_list', 'link-122');">write_func_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Methods'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'method'</tt><tt class="py-op">,</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"> <tt class="py-name">seclevel</tt><tt class="py-op">+</tt><tt class="py-number">1</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">self</tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_var_list
epydoc.docwriter.latex.LatexWriter.write_var_list" class="py-name" href="#" onclick="return doclink('link-155', 'write_var_list', 'link-123');">write_var_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Properties'</tt><tt class="py-op">,</tt> <tt class="py-name">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-string">'property'</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_var_list
epydoc.docwriter.latex.LatexWriter.write_var_list" class="py-name" href="#" onclick="return doclink('link-156', 'write_var_list', 'link-123');">write_var_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Class Variables'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"> <tt class="py-string">'classvariable'</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-157" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_var_list
epydoc.docwriter.latex.LatexWriter.write_var_list" class="py-name" href="#" onclick="return doclink('link-157', 'write_var_list', 'link-123');">write_var_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Instance Variables'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> <tt class="py-string">'instancevariable'</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-comment"># Mark the end of the class (for the index)</tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.indexterm" class="py-name" href="#" onclick="return doclink('link-158', 'indexterm', 'link-107');">indexterm</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'end'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Module hierarchy trees</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="LatexWriter.write_module_tree"></a><div id="LatexWriter.write_module_tree-def"><a name="L442"></a><tt class="py-lineno"> 442</tt> <a class="py-toggle" href="#" id="LatexWriter.write_module_tree-toggle" onclick="return toggle('LatexWriter.write_module_tree');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_module_tree">write_module_tree</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_module_tree-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_module_tree-expanded"><a name="L443"></a><tt class="py-lineno"> 443</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">doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">valdocs</tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</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">doc</tt><tt class="py-op">,</tt> <tt id="link-159" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-159', 'ModuleDoc', 'link-42');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">modules</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> <tt class="py-comment"># Write entries for all top-level modules/packages.</tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\begin{itemize}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\setlength{\\parskip}{0ex}\n'</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">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">modules</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">if</tt> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.package=epydoc.apidoc.ModuleDoc-class.html#package"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-160', 'package', 'link-160');">package</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-161" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-161', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-162" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-162', 'package', 'link-160');">package</a></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">valdocs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-163" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_module_tree_item()=epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item,Method epydoc.docwriter.latex.LatexWriter.write_module_tree_item()=epydoc.docwriter.latex.LatexWriter-class.html#write_module_tree_item"><a title="epydoc.docwriter.html.HTMLWriter.write_module_tree_item
epydoc.docwriter.latex.LatexWriter.write_module_tree_item" class="py-name" href="#" onclick="return doclink('link-163', 'write_module_tree_item', 'link-163');">write_module_tree_item</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> <tt class="py-op">+</tt><tt class="py-string">'\\end{itemize}\n'</tt> </tt>
</div><a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_module_list"></a><div id="LatexWriter.write_module_list-def"><a name="L456"></a><tt class="py-lineno"> 456</tt> <a class="py-toggle" href="#" id="LatexWriter.write_module_list-toggle" onclick="return toggle('LatexWriter.write_module_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_module_list">write_module_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_module_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_module_list-expanded"><a name="L457"></a><tt class="py-lineno"> 457</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">doc</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-164', 'submodules', 'link-23');">submodules</a></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-keyword">return</tt> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-165" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-165', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Modules'</tt><tt class="py-op">)</tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-166', 'section', 'link-108');">section</a></tt><tt class="py-op">(</tt><tt class="py-string">'Modules'</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="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\begin{itemize}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\setlength{\\parskip}{0ex}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">group_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-167" class="py-name" targets="Method epydoc.apidoc.NamespaceDoc.group_names()=epydoc.apidoc.NamespaceDoc-class.html#group_names"><a title="epydoc.apidoc.NamespaceDoc.group_names" class="py-name" href="#" onclick="return doclink('link-167', 'group_names', 'link-167');">group_names</a></tt><tt class="py-op">(</tt><tt class="py-op">)</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">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodule_groups=epydoc.apidoc.ModuleDoc-class.html#submodule_groups"><a title="epydoc.apidoc.ModuleDoc.submodule_groups" class="py-name" href="#" onclick="return doclink('link-168', 'submodule_groups', 'link-168');">submodule_groups</a></tt><tt class="py-op">[</tt><tt class="py-name">group_name</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</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">group_name</tt><tt class="py-op">:</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\item \\textbf{%s}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">group_name</tt><tt class="py-op">)</tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\begin{itemize}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">submodule</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodule_groups" class="py-name" href="#" onclick="return doclink('link-169', 'submodule_groups', 'link-168');">submodule_groups</a></tt><tt class="py-op">[</tt><tt class="py-name">group_name</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-170" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_module_tree_item
epydoc.docwriter.latex.LatexWriter.write_module_tree_item" class="py-name" href="#" onclick="return doclink('link-170', 'write_module_tree_item', 'link-163');">write_module_tree_item</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">submodule</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">if</tt> <tt class="py-name">group_name</tt><tt class="py-op">:</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \end{itemize}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\end{itemize}\n\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_module_tree_item"></a><div id="LatexWriter.write_module_tree_item-def"><a name="L476"></a><tt class="py-lineno"> 476</tt> <a class="py-toggle" href="#" id="LatexWriter.write_module_tree_item-toggle" onclick="return toggle('LatexWriter.write_module_tree_item');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_module_tree_item">write_module_tree_item</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_module_tree_item-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_module_tree_item-expanded"><a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"><tt class="py-docstring"> Helper function for L{write_module_tree} and L{write_module_list}.</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{string}</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">depth</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\item \\textbf{'</tt><tt class="py-op">)</tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt id="link-171" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-171', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-172" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-172', 'canonical_name', 'link-44');">canonical_name</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 class="py-op">+</tt><tt class="py-string">'}'</tt><tt class="py-op">)</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-173" 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-173', 'summary', 'link-173');">summary</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-174" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-174', 'UNKNOWN', 'link-113');">UNKNOWN</a></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">out</tt><tt class="py-op">(</tt><tt class="py-string">': %s\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-175" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-175', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-176" 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-176', 'summary', 'link-173');">summary</a></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-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_crossref</tt><tt class="py-op">:</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n \\textit{(Section \\ref{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-177" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-177', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">', p.~\\pageref{%s})}\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-178" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-178', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-179" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-179', 'submodules', 'link-23');">submodules</a></tt> <tt class="py-op">!=</tt> <tt id="link-180" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-180', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-181" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-181', 'submodules', 'link-23');">submodules</a></tt><tt class="py-op">:</tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">depth</tt> <tt class="py-op">+</tt> <tt class="py-string">' \\begin{itemize}\n'</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">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">depth</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\setlength{\\parskip}{0ex}\n'</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">for</tt> <tt class="py-name">submodule</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-182" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-182', 'submodules', 'link-23');">submodules</a></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">self</tt><tt class="py-op">.</tt><tt id="link-183" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_module_tree_item
epydoc.docwriter.latex.LatexWriter.write_module_tree_item" class="py-name" href="#" onclick="return doclink('link-183', 'write_module_tree_item', 'link-163');">write_module_tree_item</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">submodule</tt><tt class="py-op">,</tt> <tt class="py-name">depth</tt><tt class="py-op">+</tt><tt class="py-number">4</tt><tt class="py-op">)</tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">depth</tt> <tt class="py-op">+</tt> <tt class="py-string">' \\end{itemize}\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Base class trees</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="LatexWriter.base_tree"></a><div id="LatexWriter.base_tree-def"><a name="L500"></a><tt class="py-lineno"> 500</tt> <a class="py-toggle" href="#" id="LatexWriter.base_tree-toggle" onclick="return toggle('LatexWriter.base_tree');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#base_tree">base_tree</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">width</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">linespec</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="LatexWriter.base_tree-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.base_tree-expanded"><a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">width</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt class="py-name">width</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-184" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter._find_tree_width()=epydoc.docwriter.latex.LatexWriter-class.html#_find_tree_width"><a title="epydoc.docwriter.latex.LatexWriter._find_tree_width" class="py-name" href="#" onclick="return doclink('link-184', '_find_tree_width', 'link-184');">_find_tree_width</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-number">2</tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"> <tt class="py-name">linespec</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</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">width</tt><tt class="py-op">-</tt><tt class="py-number">4</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\\multicolumn{2}{l}{\\textbf{%s}}\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"> <tt id="link-185" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-185', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt><tt class="py-op">%</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-186" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter._base_name()=epydoc.docwriter.latex.LatexWriter-class.html#_base_name"><a title="epydoc.docwriter.latex.LatexWriter._base_name" class="py-name" href="#" onclick="return doclink('link-186', '_base_name', 'link-186');">_base_name</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="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\\end{tabular}\n\n'</tt> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"> <tt class="py-name">top</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-187" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter._base_tree_line()=epydoc.docwriter.latex.LatexWriter-class.html#_base_tree_line"><a title="epydoc.docwriter.latex.LatexWriter._base_tree_line" class="py-name" href="#" onclick="return doclink('link-187', '_base_tree_line', 'link-187');">_base_tree_line</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">width</tt><tt class="py-op">,</tt> <tt class="py-name">linespec</tt><tt class="py-op">)</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"> <tt class="py-name">top</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</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">doc</tt><tt class="py-op">,</tt> <tt id="link-188" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-188', 'ClassDoc', 'link-26');">ClassDoc</a></tt><tt class="py-op">)</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">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-189" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-189', 'bases', 'link-22');">bases</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 class="py-number">1</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="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"> <tt class="py-name">base</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-190" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-190', 'bases', 'link-22');">bases</a></tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"> <tt class="py-name">spec</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">i</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-191" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.base_tree
epydoc.docwriter.latex.LatexWriter.base_tree" class="py-name" href="#" onclick="return doclink('link-191', 'base_tree', 'link-141');">base_tree</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">width</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-name">spec</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt class="py-name">linespec</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">s</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">top</tt><tt class="py-op">:</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'\\begin{tabular}{%s}\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">width</tt><tt class="py-op">*</tt><tt class="py-string">'c'</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">s</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> </tt>
<a name="LatexWriter._base_name"></a><div id="LatexWriter._base_name-def"><a name="L523"></a><tt class="py-lineno"> 523</tt> <a class="py-toggle" href="#" id="LatexWriter._base_name-toggle" onclick="return toggle('LatexWriter._base_name');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#_base_name">_base_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter._base_name-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter._base_name-expanded"><a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-192" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-192', 'canonical_name', 'link-44');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-193" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.parse_repr=epydoc.apidoc.ValueDoc-class.html#parse_repr"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-193', 'parse_repr', 'link-193');">parse_repr</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="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-194" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-194', 'parse_repr', 'link-193');">parse_repr</a></tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'??'</tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-195" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-195', 'canonical_name', 'link-44');">canonical_name</a></tt> </tt>
</div><a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"> </tt>
<a name="LatexWriter._find_tree_width"></a><div id="LatexWriter._find_tree_width-def"><a name="L532"></a><tt class="py-lineno"> 532</tt> <a class="py-toggle" href="#" id="LatexWriter._find_tree_width-toggle" onclick="return toggle('LatexWriter._find_tree_width');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#_find_tree_width">_find_tree_width</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter._find_tree_width-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter._find_tree_width-expanded"><a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-196" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-196', 'ClassDoc', 'link-26');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">2</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"> <tt class="py-name">width</tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-197" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-197', 'bases', 'link-22');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"> <tt class="py-name">width</tt> <tt class="py-op">=</tt> <tt class="py-name">max</tt><tt class="py-op">(</tt><tt class="py-name">width</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-198" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._find_tree_width" class="py-name" href="#" onclick="return doclink('link-198', '_find_tree_width', 'link-184');">_find_tree_width</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">width</tt> </tt>
</div><a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"> </tt>
<a name="LatexWriter._base_tree_line"></a><div id="LatexWriter._base_tree_line-def"><a name="L539"></a><tt class="py-lineno"> 539</tt> <a class="py-toggle" href="#" id="LatexWriter._base_tree_line-toggle" onclick="return toggle('LatexWriter._base_tree_line');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#_base_tree_line">_base_tree_line</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">width</tt><tt class="py-op">,</tt> <tt class="py-param">linespec</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter._base_tree_line-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter._base_tree_line-expanded"><a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-name">base_name</tt> <tt class="py-op">=</tt> <tt id="link-199" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-199', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-200" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._base_name" class="py-name" href="#" onclick="return doclink('link-200', '_base_name', 'link-186');">_base_name</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> <tt class="py-comment"># linespec is a list of booleans.</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'%% Line for %s, linespec=%s\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">base_name</tt><tt class="py-op">,</tt> <tt class="py-name">linespec</tt><tt class="py-op">)</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"> <tt class="py-name">labelwidth</tt> <tt class="py-op">=</tt> <tt class="py-name">width</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">*</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">linespec</tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-number">2</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"> <tt class="py-comment"># The base class name.</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-string">'\\multicolumn{%s}{r}{'</tt> <tt class="py-op">%</tt> <tt class="py-name">labelwidth</tt><tt class="py-op">)</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\\settowidth{\\BCL}{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">base_name</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\\multirow{2}{\\BCL}{%s}}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">base_name</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-comment"># The vertical bars for other base classes (top half)</tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">vbar</tt> <tt class="py-keyword">in</tt> <tt class="py-name">linespec</tt><tt class="py-op">:</tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">vbar</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'&&\\multicolumn{1}{|c}{}\n'</tt> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'&&\n'</tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"> <tt class="py-comment"># The horizontal line.</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">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">' \\\\\\cline{%s-%s}\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">labelwidth</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">labelwidth</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"> <tt class="py-comment"># The vertical bar for this base class.</tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">s</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-name">labelwidth</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\\multicolumn{1}{c|}{}\n'</tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt class="py-comment"># The vertical bars for other base classes (bottom half)</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">vbar</tt> <tt class="py-keyword">in</tt> <tt class="py-name">linespec</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">if</tt> <tt class="py-name">vbar</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'&\\multicolumn{1}{|c}{}&\n'</tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'&&\n'</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">' \\\\\n'</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Class List</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="LatexWriter.write_class_list"></a><div id="LatexWriter.write_class_list-def"><a name="L576"></a><tt class="py-lineno"> 576</tt> <a class="py-toggle" href="#" id="LatexWriter.write_class_list-toggle" onclick="return toggle('LatexWriter.write_class_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_class_list">write_class_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_class_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_class_list-expanded"><a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt id="link-201" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-201', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">group_name</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-202" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-202', 'select_variables', 'link-124');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">=</tt><tt class="py-name">group_name</tt><tt class="py-op">,</tt> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-string">'class'</tt><tt class="py-op">,</tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">group_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-203" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_names" class="py-name" href="#" onclick="return doclink('link-203', 'group_names', 'link-167');">group_names</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-comment"># Discard any empty groups; and return if they're all empty.</tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">g</tt><tt class="py-op">,</tt><tt class="py-name">vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">g</tt><tt class="py-op">,</tt><tt class="py-name">vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">groups</tt> <tt class="py-keyword">if</tt> <tt class="py-name">vars</tt><tt class="py-op">]</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">groups</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> <tt class="py-comment"># Write a header.</tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-204', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Classes'</tt><tt class="py-op">)</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-205" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-205', 'section', 'link-108');">section</a></tt><tt class="py-op">(</tt><tt class="py-string">'Classes'</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="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\begin{itemize}'</tt><tt class="py-op">)</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\setlength{\\parskip}{0ex}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-206" 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-206', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_docs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">groups</tt><tt class="py-op">:</tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-207" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-207', 'name', 'link-206');">name</a></tt><tt class="py-op">:</tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\item \\textbf{%s}\n'</tt> <tt class="py-op">%</tt> <tt id="link-208" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-208', 'name', 'link-206');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\begin{itemize}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> <tt class="py-comment"># Add the lines for each class</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-209" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_class_list_line()=epydoc.docwriter.latex.LatexWriter-class.html#write_class_list_line"><a title="epydoc.docwriter.latex.LatexWriter.write_class_list_line" class="py-name" href="#" onclick="return doclink('link-209', 'write_class_list_line', 'link-209');">write_class_list_line</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-210" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-210', 'name', 'link-206');">name</a></tt><tt class="py-op">:</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\end{itemize}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\end{itemize}\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_class_list_line"></a><div id="LatexWriter.write_class_list_line-def"><a name="L605"></a><tt class="py-lineno"> 605</tt> <a class="py-toggle" href="#" id="LatexWriter.write_class_list_line-toggle" onclick="return toggle('LatexWriter.write_class_list_line');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_class_list_line">write_class_list_line</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_class_list_line-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_class_list_line-expanded"><a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-211', 'value', 'link-126');">value</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-212" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-212', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-comment"># shouldn't happen</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-213', 'value', 'link-126');">value</a></tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\item \\textbf{'</tt><tt class="py-op">)</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt id="link-214" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-214', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-215" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-215', 'name', 'link-206');">name</a></tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'}'</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">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-216" 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-216', 'summary', 'link-173');">summary</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-217" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-217', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">': %s\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-218" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-218', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-219" 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-219', 'summary', 'link-173');">summary</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</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">_crossref</tt><tt class="py-op">:</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'\n \\textit{(Section \\ref{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-220" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-220', 'label', 'link-111');">label</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="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">', p.~\\pageref{%s})}\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-221" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-221', 'label', 'link-111');">label</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>
</div><a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Function List</tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-222" class="py-name" targets="Variable epydoc.docwriter.latex.LatexWriter._FUNC_GROUP_HEADER=epydoc.docwriter.latex.LatexWriter-class.html#_FUNC_GROUP_HEADER"><a title="epydoc.docwriter.latex.LatexWriter._FUNC_GROUP_HEADER" class="py-name" href="#" onclick="return doclink('link-222', '_FUNC_GROUP_HEADER', 'link-222');">_FUNC_GROUP_HEADER</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\n\\large{\\textbf{\\textit{%s}}}\n\n'</tt> </tt>
<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_func_list"></a><div id="LatexWriter.write_func_list-def"><a name="L621"></a><tt class="py-lineno"> 621</tt> <a class="py-toggle" href="#" id="LatexWriter.write_func_list-toggle" onclick="return toggle('LatexWriter.write_func_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_func_list">write_func_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">heading</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">value_type</tt><tt class="py-op">,</tt> <tt class="py-param">seclevel</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_func_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_func_list-expanded"><a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"> <tt class="py-comment"># Divide all public variables of the given type into groups.</tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt id="link-223" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-223', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">group_name</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-224" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-224', 'select_variables', 'link-124');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">=</tt><tt class="py-name">group_name</tt><tt class="py-op">,</tt> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> <tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-name">value_type</tt><tt class="py-op">,</tt> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</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">for</tt> <tt class="py-name">group_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-225" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_names" class="py-name" href="#" onclick="return doclink('link-225', 'group_names', 'link-167');">group_names</a></tt><tt class="py-op">(</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>
<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"> <tt class="py-comment"># Discard any empty groups; and return if they're all empty.</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">g</tt><tt class="py-op">,</tt><tt class="py-name">vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">g</tt><tt class="py-op">,</tt><tt class="py-name">vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">groups</tt> <tt class="py-keyword">if</tt> <tt class="py-name">vars</tt><tt class="py-op">]</tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">groups</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"> <tt class="py-comment"># Write a header.</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-226" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-226', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">heading</tt><tt class="py-op">)</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-227" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-227', 'section', 'link-108');">section</a></tt><tt class="py-op">(</tt><tt class="py-name">heading</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</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>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"> <tt class="py-comment"># Write a section for each group.</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">grouped_inh_vars</tt> <tt class="py-op">=</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-keyword">for</tt> <tt id="link-228" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-228', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_docs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">groups</tt><tt class="py-op">:</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-229" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_func_group()=epydoc.docwriter.latex.LatexWriter-class.html#write_func_group"><a title="epydoc.docwriter.latex.LatexWriter.write_func_group" class="py-name" href="#" onclick="return doclink('link-229', 'write_func_group', 'link-229');">write_func_group</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-230" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-230', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_docs</tt><tt class="py-op">,</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">)</tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"> <tt class="py-comment"># Write a section for each inheritance pseudo-group (used if</tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># inheritance=='grouped')</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">grouped_inh_vars</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">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-231" class="py-name" targets="Method epydoc.apidoc.ClassDoc.mro()=epydoc.apidoc.ClassDoc-class.html#mro"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-231', 'mro', 'link-231');">mro</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'Inherited from %s'</tt> <tt class="py-op">%</tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"> <tt id="link-232" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-232', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-233" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-233', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</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">_crossref</tt> <tt class="py-keyword">and</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt><tt class="py-op">:</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-string">'\\textit{(Section \\ref{%s})}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-234" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-234', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">base</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">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-235" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._FUNC_GROUP_HEADER" class="py-name" href="#" onclick="return doclink('link-235', '_FUNC_GROUP_HEADER', 'link-222');">_FUNC_GROUP_HEADER</a></tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">hdr</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-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">[</tt><tt class="py-name">base</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 class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-236" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_func_list_box()=epydoc.docwriter.latex.LatexWriter-class.html#write_func_list_box"><a title="epydoc.docwriter.latex.LatexWriter.write_func_list_box" class="py-name" href="#" onclick="return doclink('link-236', 'write_func_list_box', 'link-236');">write_func_list_box</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_func_group"></a><div id="LatexWriter.write_func_group-def"><a name="L656"></a><tt class="py-lineno"> 656</tt> <a class="py-toggle" href="#" id="LatexWriter.write_func_group-toggle" onclick="return toggle('LatexWriter.write_func_group');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_func_group">write_func_group</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">var_docs</tt><tt class="py-op">,</tt> <tt class="py-param">grouped_inh_vars</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_func_group-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_func_group-expanded"><a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"> <tt class="py-comment"># Split up the var_docs list, according to the way each var</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># should be displayed:</tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - listed_inh_vars -- for listed inherited variables.</tt> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - grouped_inh_vars -- for grouped inherited variables.</tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - normal_vars -- for all other variables.</tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">listed_inh_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-237" class="py-name" targets="Method epydoc.apidoc.DocIndex.container()=epydoc.apidoc.DocIndex-class.html#container,Method epydoc.apidoc.DottedName.container()=epydoc.apidoc.DottedName-class.html#container,Variable epydoc.apidoc.VariableDoc.container=epydoc.apidoc.VariableDoc-class.html#container"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-237', 'container', 'link-237');">container</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">doc</tt><tt class="py-op">:</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> <tt class="py-name">base</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-238" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-238', 'container', 'link-237');">container</a></tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">base</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">class_set</tt> <tt class="py-keyword">or</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 class="py-name">_inheritance</tt> <tt class="py-op">==</tt> <tt class="py-string">'listed'</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-name">listed_inh_vars</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">base</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">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt> <tt class="py-op">==</tt> <tt class="py-string">'grouped'</tt><tt class="py-op">:</tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">base</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">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> <tt class="py-comment"># Write a header for the group.</tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-239" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-239', 'name', 'link-206');">name</a></tt><tt class="py-op">:</tt> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-240" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._FUNC_GROUP_HEADER" class="py-name" href="#" onclick="return doclink('link-240', '_FUNC_GROUP_HEADER', 'link-222');">_FUNC_GROUP_HEADER</a></tt> <tt class="py-op">%</tt> <tt id="link-241" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-241', 'name', 'link-206');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"> <tt class="py-comment"># Write an entry for each normal var:</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">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">normal_vars</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">self</tt><tt class="py-op">.</tt><tt id="link-242" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_func_list_box" class="py-name" href="#" onclick="return doclink('link-242', 'write_func_list_box', 'link-236');">write_func_list_box</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"> <tt class="py-comment"># Write a subsection for inherited vars:</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">listed_inh_vars</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 id="link-243" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_func_inheritance_list()=epydoc.docwriter.latex.LatexWriter-class.html#write_func_inheritance_list"><a title="epydoc.docwriter.latex.LatexWriter.write_func_inheritance_list" class="py-name" href="#" onclick="return doclink('link-243', 'write_func_inheritance_list', 'link-243');">write_func_inheritance_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">)</tt> </tt>
</div><a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_func_inheritance_list"></a><div id="LatexWriter.write_func_inheritance_list-def"><a name="L687"></a><tt class="py-lineno"> 687</tt> <a class="py-toggle" href="#" id="LatexWriter.write_func_inheritance_list-toggle" onclick="return toggle('LatexWriter.write_func_inheritance_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_func_inheritance_list">write_func_inheritance_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">listed_inh_vars</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_func_inheritance_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_func_inheritance_list-expanded"><a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-244" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-244', 'mro', 'link-231');">mro</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-comment">#if str(base.canonical_name) == 'object': continue</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var_docs</tt> <tt class="py-op">=</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">[</tt><tt class="py-name">base</tt><tt class="py-op">]</tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</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">_public_filter</tt><tt class="py-op">:</tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> <tt class="py-name">var_docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-245" 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-245', 'v', 'link-245');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-246" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-246', 'v', 'link-245');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt> <tt class="py-keyword">if</tt> <tt id="link-247" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-247', 'v', 'link-245');">v</a></tt><tt class="py-op">.</tt><tt id="link-248" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_public=epydoc.apidoc.VariableDoc-class.html#is_public"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-248', 'is_public', 'link-248');">is_public</a></tt><tt class="py-op">]</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'Inherited from %s'</tt> <tt class="py-op">%</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt id="link-249" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-249', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-250" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-250', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</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">_crossref</tt> <tt class="py-keyword">and</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt><tt class="py-op">:</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-string">'\\textit{(Section \\ref{%s})}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-251" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-251', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-252" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._FUNC_GROUP_HEADER" class="py-name" href="#" onclick="return doclink('link-252', '_FUNC_GROUP_HEADER', 'link-222');">_FUNC_GROUP_HEADER</a></tt> <tt class="py-op">%</tt> <tt class="py-name">hdr</tt><tt class="py-op">)</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\begin{quote}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'%s\n'</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>
<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-string">'%s()'</tt> <tt class="py-op">%</tt> <tt id="link-253" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-253', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-254" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-254', 'name', 'link-206');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt><tt class="py-op">]</tt><tt class="py-op">)</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">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\end{quote}\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_func_list_box"></a><div id="LatexWriter.write_func_list_box-def"><a name="L707"></a><tt class="py-lineno"> 707</tt> <a class="py-toggle" href="#" id="LatexWriter.write_func_list_box-toggle" onclick="return toggle('LatexWriter.write_func_list_box');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_func_list_box">write_func_list_box</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_func_list_box-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_func_list_box-expanded"><a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-255" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-255', 'value', 'link-126');">value</a></tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-name">is_inherited</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-256" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.overrides=epydoc.apidoc.VariableDoc-class.html#overrides"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-256', 'overrides', 'link-256');">overrides</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-257" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-257', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</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-comment"># nb: this gives the containing section, not a reference</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># directly to the function.</tt> </tt>
<a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">is_inherited</tt><tt class="py-op">:</tt> </tt>
<a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\label{%s}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-258" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-258', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' %s\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-259" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.indexterm" class="py-name" href="#" onclick="return doclink('link-259', 'indexterm', 'link-107');">indexterm</a></tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-comment"># Start box for this function.</tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\vspace{0.5ex}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\hspace{.8\\funcindent}'</tt><tt class="py-op">)</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\begin{boxedminipage}{\\funcwidth}\n\n'</tt><tt class="py-op">)</tt> </tt>
<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-comment"># Function signature.</tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' %s\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-260" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.function_signature()=epydoc.docwriter.html.HTMLWriter-class.html#function_signature,Method epydoc.docwriter.latex.LatexWriter.function_signature()=epydoc.docwriter.latex.LatexWriter-class.html#function_signature"><a title="epydoc.docwriter.html.HTMLWriter.function_signature
epydoc.docwriter.latex.LatexWriter.function_signature" class="py-name" href="#" onclick="return doclink('link-260', 'function_signature', 'link-260');">function_signature</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-261" 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-261', 'docstring', 'link-261');">docstring</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-262" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-262', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-263" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-263', 'docstring', 'link-261');">docstring</a></tt><tt class="py-op">.</tt><tt class="py-name">strip</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 class="py-op">:</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\vspace{-1.5ex}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\rule{\\textwidth}{0.5\\fboxrule}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt class="py-comment"># Description</tt> </tt>
<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">"\\setlength{\\parskip}{2ex}\n"</tt><tt class="py-op">)</tt> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-264" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-264', 'descr', 'link-112');">descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-265" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-265', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-266" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-266', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-267" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-267', 'descr', 'link-112');">descr</a></tt><tt class="py-op">,</tt> <tt class="py-number">4</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"> <tt class="py-comment"># Parameters</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">"\\setlength{\\parskip}{1ex}\n"</tt><tt class="py-op">)</tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-268" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_descrs=epydoc.apidoc.RoutineDoc-class.html#arg_descrs"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-268', 'arg_descrs', 'link-268');">arg_descrs</a></tt> <tt class="py-keyword">or</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-269" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_types=epydoc.apidoc.RoutineDoc-class.html#arg_types"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-269', 'arg_types', 'link-269');">arg_types</a></tt><tt class="py-op">:</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"> <tt class="py-comment"># Find the longest name.</tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">longest</tt> <tt class="py-op">=</tt> <tt class="py-name">max</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-name">len</tt><tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-270" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-270', 'arg_types', 'link-269');">arg_types</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">names</tt><tt class="py-op">,</tt> <tt class="py-name">descrs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-271" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-271', 'arg_descrs', 'link-268');">arg_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt class="py-name">longest</tt> <tt class="py-op">=</tt> <tt class="py-name">max</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">longest</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">names</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-comment"># Table header.</tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\textbf{Parameters}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\vspace{-1ex}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\begin{quote}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\begin{Ventry}{%s}\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">longest</tt><tt class="py-op">*</tt><tt class="py-string">'x'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-comment"># Add params that have @type but not @param info:</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-272" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-272', 'arg_descrs', 'link-268');">arg_descrs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-273" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-273', 'arg_descrs', 'link-268');">arg_descrs</a></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">args</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">arg_names</tt><tt class="py-op">,</tt> <tt class="py-name">arg_descr</tt> <tt class="py-keyword">in</tt> <tt id="link-274" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-274', 'arg_descrs', 'link-268');">arg_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">arg_names</tt><tt class="py-op">)</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-275" 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-275', 'arg', 'link-275');">arg</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-276" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-276', 'value', 'link-126');">value</a></tt><tt class="py-op">.</tt><tt id="link-277" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-277', 'arg_types', 'link-269');">arg_types</a></tt><tt class="py-op">:</tt> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-278" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-278', 'arg', 'link-275');">arg</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> <tt id="link-279" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-279', 'arg_descrs', 'link-268');">arg_descrs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-280" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-280', 'arg', 'link-275');">arg</a></tt><tt class="py-op">]</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="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt class="py-comment"># Display params</tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">arg_names</tt><tt class="py-op">,</tt> <tt class="py-name">arg_descr</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-281" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-281', 'arg_descrs', 'link-268');">arg_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"> <tt class="py-name">arg_name</tt> <tt class="py-op">=</tt> <tt id="link-282" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-282', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></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-name">arg_names</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'%s\\item[%s]\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">10</tt><tt class="py-op">,</tt> <tt class="py-name">arg_name</tt><tt class="py-op">)</tt><tt class="py-op">)</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">arg_descr</tt><tt class="py-op">:</tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-283" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-283', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">arg_descr</tt><tt class="py-op">,</tt> <tt class="py-number">10</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">arg_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">arg_names</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">arg_typ</tt> <tt class="py-op">=</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-284" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-284', 'arg_types', 'link-269');">arg_types</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">arg_name</tt><tt class="py-op">)</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arg_typ</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="L764"></a><tt class="py-lineno"> 764</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">arg_names</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="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> <tt class="py-name">lhs</tt> <tt class="py-op">=</tt> <tt class="py-string">'type'</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt class="py-name">lhs</tt> <tt class="py-op">=</tt> <tt class="py-string">'type of %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">arg_name</tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt class="py-name">rhs</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-285" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-285', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">arg_typ</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="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'%s{\\it (%s=%s)}\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">12</tt><tt class="py-op">,</tt> <tt class="py-name">lhs</tt><tt class="py-op">,</tt> <tt class="py-name">rhs</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\end{Ventry}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\end{quote}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"> <tt class="py-comment"># Returns</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">rdescr</tt> <tt class="py-op">=</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-286" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_descr=epydoc.apidoc.RoutineDoc-class.html#return_descr,Method epydoc.docwriter.html.HTMLWriter.return_descr()=epydoc.docwriter.html.HTMLWriter-class.html#return_descr"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-286', 'return_descr', 'link-286');">return_descr</a></tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"> <tt class="py-name">rtype</tt> <tt class="py-op">=</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-287" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_type=epydoc.apidoc.RoutineDoc-class.html#return_type,Method epydoc.docwriter.html.HTMLWriter.return_type()=epydoc.docwriter.html.HTMLWriter-class.html#return_type"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-287', 'return_type', 'link-287');">return_type</a></tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rdescr</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-288" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-288', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">rtype</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-289" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-289', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\textbf{Return Value}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\vspace{-1ex}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\begin{quote}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rdescr</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-290" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-290', 'UNKNOWN', 'link-113');">UNKNOWN</a></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-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-291" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-291', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">rdescr</tt><tt class="py-op">,</tt> <tt class="py-number">6</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rtype</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-292" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-292', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'{\\it (type=%s)}\n\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-293" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-293', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">rtype</tt><tt class="py-op">,</tt> <tt class="py-number">6</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 class="py-op">)</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">rtype</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-294" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-294', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-295" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-295', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">rtype</tt><tt class="py-op">,</tt> <tt class="py-number">6</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\end{quote}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"> <tt class="py-comment"># Raises</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-296" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.exception_descrs=epydoc.apidoc.RoutineDoc-class.html#exception_descrs"><a title="epydoc.apidoc.RoutineDoc.exception_descrs" class="py-name" href="#" onclick="return doclink('link-296', 'exception_descrs', 'link-296');">exception_descrs</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-297" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-297', 'UNKNOWN', 'link-113');">UNKNOWN</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-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\textbf{Raises}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\vspace{-1ex}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\begin{quote}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\begin{description}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-298" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-298', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt id="link-299" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-299', 'descr', 'link-112');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-300" class="py-name"><a title="epydoc.apidoc.RoutineDoc.exception_descrs" class="py-name" href="#" onclick="return doclink('link-300', 'exception_descrs', 'link-296');">exception_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">10</tt><tt class="py-op">+</tt><tt class="py-string">'\\item[\\texttt{%s}]\n\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt id="link-301" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-301', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt id="link-302" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-302', 'name', 'link-206');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-303" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-303', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt id="link-304" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-304', 'descr', 'link-112');">descr</a></tt><tt class="py-op">,</tt> <tt class="py-number">10</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\end{description}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">6</tt><tt class="py-op">+</tt><tt class="py-string">'\\end{quote}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt class="py-comment">## Overrides</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-305" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-305', 'overrides', 'link-256');">overrides</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-306" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-306', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' Overrides: '</tt> <tt class="py-op">+</tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt id="link-307" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-307', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt><tt class="py-op">%</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-308" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-308', 'overrides', 'link-256');">overrides</a></tt><tt class="py-op">.</tt><tt id="link-309" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-309', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-310" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-310', 'docstring', 'link-261');">docstring</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-311" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-311', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-312" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-312', 'overrides', 'link-256');">overrides</a></tt><tt class="py-op">.</tt><tt id="link-313" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-313', 'value', 'link-126');">value</a></tt><tt class="py-op">.</tt><tt id="link-314" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-314', 'docstring', 'link-261');">docstring</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-315" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-315', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \textit{(inherited documentation)}'</tt><tt class="py-op">)</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-comment"># Add version, author, warnings, requirements, notes, etc.</tt> </tt>
<a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-316" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_fields
epydoc.docwriter.latex.LatexWriter.write_standard_fields" class="py-name" href="#" onclick="return doclink('link-316', 'write_standard_fields', 'link-116');">write_standard_fields</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">func_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\end{boxedminipage}\n\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.function_signature"></a><div id="LatexWriter.function_signature-def"><a name="L816"></a><tt class="py-lineno"> 816</tt> <a class="py-toggle" href="#" id="LatexWriter.function_signature-toggle" onclick="return toggle('LatexWriter.function_signature');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#function_signature">function_signature</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.function_signature-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.function_signature-expanded"><a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-317" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-317', 'value', 'link-126');">value</a></tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> <tt class="py-name">func_name</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-318" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-318', 'name', 'link-206');">name</a></tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> <tt class="py-comment"># This should never happen, but just in case:</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-319" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-319', 'UNKNOWN', 'link-113');">UNKNOWN</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 class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'\\raggedright \\textbf{%s}(...)'</tt> <tt class="py-op">%</tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt id="link-320" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-320', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">func_name</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-321" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posargs=epydoc.apidoc.RoutineDoc-class.html#posargs"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-321', 'posargs', 'link-321');">posargs</a></tt> <tt class="py-op">==</tt> <tt id="link-322" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-322', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'...'</tt><tt class="py-op">]</tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-323" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.func_arg()=epydoc.docwriter.html.HTMLWriter-class.html#func_arg,Method epydoc.docwriter.latex.LatexWriter.func_arg()=epydoc.docwriter.latex.LatexWriter-class.html#func_arg"><a title="epydoc.docwriter.html.HTMLWriter.func_arg
epydoc.docwriter.latex.LatexWriter.func_arg" class="py-name" href="#" onclick="return doclink('link-323', 'func_arg', 'link-323');">func_arg</a></tt><tt class="py-op">(</tt><tt id="link-324" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-324', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">default</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-325" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-325', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">default</tt><tt class="py-op">)</tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"> <tt class="py-keyword">in</tt> <tt class="py-name">zip</tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-326" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-326', 'posargs', 'link-321');">posargs</a></tt><tt class="py-op">,</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-327" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posarg_defaults=epydoc.apidoc.RoutineDoc-class.html#posarg_defaults"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-327', 'posarg_defaults', 'link-327');">posarg_defaults</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-328" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.vararg=epydoc.apidoc.RoutineDoc-class.html#vararg"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-328', 'vararg', 'link-328');">vararg</a></tt><tt class="py-op">:</tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-329" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-329', 'vararg', 'link-328');">vararg</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'...'</tt><tt class="py-op">:</tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'\\textit{...}'</tt><tt class="py-op">)</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'*\\textit{%s}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> <tt id="link-330" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-330', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-331" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-331', 'vararg', 'link-328');">vararg</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-332" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.kwarg=epydoc.apidoc.RoutineDoc-class.html#kwarg"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-332', 'kwarg', 'link-332');">kwarg</a></tt><tt class="py-op">:</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'**\\textit{%s}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt id="link-333" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-333', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-334" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-334', 'kwarg', 'link-332');">kwarg</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'\\raggedright \\textbf{%s}(%s)'</tt> <tt class="py-op">%</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-335" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-335', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">func_name</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-name">args</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.func_arg"></a><div id="LatexWriter.func_arg-def"><a name="L842"></a><tt class="py-lineno"> 842</tt> <a class="py-toggle" href="#" id="LatexWriter.func_arg-toggle" onclick="return toggle('LatexWriter.func_arg');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#func_arg">func_arg</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">default</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.func_arg-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.func_arg-expanded"><a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'\\textit{%s}'</tt> <tt class="py-op">%</tt> <tt id="link-336" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-336', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-337" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._arg_name()=epydoc.docwriter.html.HTMLWriter-class.html#_arg_name,Method epydoc.docwriter.latex.LatexWriter._arg_name()=epydoc.docwriter.latex.LatexWriter-class.html#_arg_name"><a title="epydoc.docwriter.html.HTMLWriter._arg_name
epydoc.docwriter.latex.LatexWriter._arg_name" class="py-name" href="#" onclick="return doclink('link-337', '_arg_name', 'link-337');">_arg_name</a></tt><tt class="py-op">(</tt><tt id="link-338" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-338', 'name', 'link-206');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">default</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="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'={\\tt %s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">default</tt><tt class="py-op">.</tt><tt id="link-339" class="py-name" targets="Method epydoc.apidoc.ValueDoc.summary_pyval_repr()=epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr"><a title="epydoc.apidoc.ValueDoc.summary_pyval_repr" class="py-name" href="#" onclick="return doclink('link-339', 'summary_pyval_repr', 'link-339');">summary_pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-340" class="py-name" targets="Method epydoc.markup.ConcatenatedDocstring.to_latex()=epydoc.markup.ConcatenatedDocstring-class.html#to_latex,Method epydoc.markup.ParsedDocstring.to_latex()=epydoc.markup.ParsedDocstring-class.html#to_latex,Method epydoc.markup.epytext.ParsedEpytextDocstring.to_latex()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_latex,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.to_latex()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_latex,Method epydoc.markup.restructuredtext.ParsedRstDocstring.to_latex()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_latex"><a title="epydoc.markup.ConcatenatedDocstring.to_latex
epydoc.markup.ParsedDocstring.to_latex
epydoc.markup.epytext.ParsedEpytextDocstring.to_latex
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_latex
epydoc.markup.restructuredtext.ParsedRstDocstring.to_latex" class="py-name" href="#" onclick="return doclink('link-340', 'to_latex', 'link-340');">to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> </tt>
<a name="LatexWriter._arg_name"></a><div id="LatexWriter._arg_name-def"><a name="L848"></a><tt class="py-lineno"> 848</tt> <a class="py-toggle" href="#" id="LatexWriter._arg_name-toggle" onclick="return toggle('LatexWriter._arg_name');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#_arg_name">_arg_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter._arg_name-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter._arg_name-expanded"><a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-341" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-341', 'arg', 'link-275');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">basestring</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 class="py-keyword">return</tt> <tt id="link-342" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-342', 'arg', 'link-275');">arg</a></tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-343" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-343', 'arg', 'link-275');">arg</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="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'(%s,)'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-344" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._arg_name
epydoc.docwriter.latex.LatexWriter._arg_name" class="py-name" href="#" onclick="return doclink('link-344', '_arg_name', 'link-337');">_arg_name</a></tt><tt class="py-op">(</tt><tt id="link-345" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-345', 'arg', 'link-275');">arg</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="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'(%s)'</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">self</tt><tt class="py-op">.</tt><tt id="link-346" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._arg_name
epydoc.docwriter.latex.LatexWriter._arg_name" class="py-name" href="#" onclick="return doclink('link-346', '_arg_name', 'link-337');">_arg_name</a></tt><tt class="py-op">(</tt><tt class="py-name">a</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">a</tt> <tt class="py-keyword">in</tt> <tt id="link-347" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-347', 'arg', 'link-275');">arg</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Variable List</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-348" class="py-name" targets="Variable epydoc.docwriter.latex.LatexWriter._VAR_GROUP_HEADER=epydoc.docwriter.latex.LatexWriter-class.html#_VAR_GROUP_HEADER"><a title="epydoc.docwriter.latex.LatexWriter._VAR_GROUP_HEADER" class="py-name" href="#" onclick="return doclink('link-348', '_VAR_GROUP_HEADER', 'link-348');">_VAR_GROUP_HEADER</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\\multicolumn{2}{|l|}{\\textit{%s}}\\\\\n'</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> <tt class="py-comment"># Also used for the property list.</tt> </tt>
<a name="LatexWriter.write_var_list"></a><div id="LatexWriter.write_var_list-def"><a name="L862"></a><tt class="py-lineno"> 862</tt> <a class="py-toggle" href="#" id="LatexWriter.write_var_list-toggle" onclick="return toggle('LatexWriter.write_var_list');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_var_list">write_var_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">heading</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">value_type</tt><tt class="py-op">,</tt> <tt class="py-param">seclevel</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_var_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_var_list-expanded"><a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt id="link-349" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-349', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">group_name</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-350" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-350', 'select_variables', 'link-124');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">=</tt><tt class="py-name">group_name</tt><tt class="py-op">,</tt> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> <tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-name">value_type</tt><tt class="py-op">,</tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">group_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-351" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_names" class="py-name" href="#" onclick="return doclink('link-351', 'group_names', 'link-167');">group_names</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> <tt class="py-comment"># Discard any empty groups; and return if they're all empty.</tt> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">g</tt><tt class="py-op">,</tt><tt class="py-name">vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">g</tt><tt class="py-op">,</tt><tt class="py-name">vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">groups</tt> <tt class="py-keyword">if</tt> <tt class="py-name">vars</tt><tt class="py-op">]</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">groups</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> <tt class="py-comment"># Write a header.</tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-352" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_start_of" class="py-name" href="#" onclick="return doclink('link-352', 'write_start_of', 'link-82');">write_start_of</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">heading</tt><tt class="py-op">)</tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-353" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-353', 'section', 'link-108');">section</a></tt><tt class="py-op">(</tt><tt class="py-name">heading</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> <tt class="py-comment"># [xx] without this, there's a huge gap before the table -- why??</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' \\vspace{-1cm}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\hspace{\\varindent}'</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">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\begin{longtable}'</tt><tt class="py-op">)</tt> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'{|p{\\varnamewidth}|'</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">out</tt><tt class="py-op">(</tt><tt class="py-string">'p{\\vardescrwidth}|l}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> <tt class="py-comment"># Set up the headers & footer (this makes the table span</tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># multiple pages in a happy way).</tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2} '</tt><tt class="py-op">)</tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\centering \\textbf{Name} & '</tt><tt class="py-op">)</tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\centering \\textbf{Description}& \\\\\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\endhead'</tt><tt class="py-op">)</tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}'</tt><tt class="py-op">)</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\multicolumn{3}{r}{\\small\\textit{'</tt><tt class="py-op">)</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'continued on next page}}\\\\'</tt><tt class="py-op">)</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\endfoot'</tt><tt class="py-op">)</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\endlastfoot'</tt><tt class="py-op">)</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"> <tt class="py-comment"># Write a section for each group.</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">grouped_inh_vars</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-keyword">for</tt> <tt id="link-354" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-354', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_docs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">groups</tt><tt class="py-op">:</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-355" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_var_group()=epydoc.docwriter.latex.LatexWriter-class.html#write_var_group"><a title="epydoc.docwriter.latex.LatexWriter.write_var_group" class="py-name" href="#" onclick="return doclink('link-355', 'write_var_group', 'link-355');">write_var_group</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-356" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-356', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_docs</tt><tt class="py-op">,</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">)</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"> <tt class="py-comment"># Write a section for each inheritance pseudo-group (used if</tt> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># inheritance=='grouped')</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-357" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-357', 'mro', 'link-231');">mro</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'Inherited from %s'</tt> <tt class="py-op">%</tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> <tt id="link-358" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-358', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-359" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-359', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</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">_crossref</tt> <tt class="py-keyword">and</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt><tt class="py-op">:</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-string">' \\textit{(Section \\ref{%s})}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-360" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-360', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-361" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._VAR_GROUP_HEADER" class="py-name" href="#" onclick="return doclink('link-361', '_VAR_GROUP_HEADER', 'link-348');">_VAR_GROUP_HEADER</a></tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">hdr</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">[</tt><tt class="py-name">base</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</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">var_doc</tt><tt class="py-op">.</tt><tt class="py-name">value3</tt><tt class="py-op">,</tt> <tt id="link-362" class="py-name" targets="Class epydoc.apidoc.PropertyDoc=epydoc.apidoc.PropertyDoc-class.html"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-362', 'PropertyDoc', 'link-362');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-363" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_property_list_line()=epydoc.docwriter.latex.LatexWriter-class.html#write_property_list_line"><a title="epydoc.docwriter.latex.LatexWriter.write_property_list_line" class="py-name" href="#" onclick="return doclink('link-363', 'write_property_list_line', 'link-363');">write_property_list_line</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-364" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_var_list_line()=epydoc.docwriter.latex.LatexWriter-class.html#write_var_list_line"><a title="epydoc.docwriter.latex.LatexWriter.write_var_list_line" class="py-name" href="#" onclick="return doclink('link-364', 'write_var_list_line', 'link-364');">write_var_list_line</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\end{longtable}\n\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_var_group"></a><div id="LatexWriter.write_var_group-def"><a name="L925"></a><tt class="py-lineno"> 925</tt> <a class="py-toggle" href="#" id="LatexWriter.write_var_group-toggle" onclick="return toggle('LatexWriter.write_var_group');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_var_group">write_var_group</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">var_docs</tt><tt class="py-op">,</tt> <tt class="py-param">grouped_inh_vars</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_var_group-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_var_group-expanded"><a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt class="py-comment"># Split up the var_docs list, according to the way each var</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># should be displayed:</tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - listed_inh_vars -- for listed inherited variables.</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - grouped_inh_vars -- for grouped inherited variables.</tt> </tt>
<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - normal_vars -- for all other variables.</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">listed_inh_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-365" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-365', 'container', 'link-237');">container</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">doc</tt><tt class="py-op">:</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> <tt class="py-name">base</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-366" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-366', 'container', 'link-237');">container</a></tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">base</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">class_set</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt> <tt class="py-op">==</tt> <tt class="py-string">'listed'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">base</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">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt> <tt class="py-op">==</tt> <tt class="py-string">'grouped'</tt><tt class="py-op">:</tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">base</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">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> <tt class="py-comment"># Write a header for the group.</tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-367" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-367', 'name', 'link-206');">name</a></tt><tt class="py-op">:</tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-368" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._VAR_GROUP_HEADER" class="py-name" href="#" onclick="return doclink('link-368', '_VAR_GROUP_HEADER', 'link-348');">_VAR_GROUP_HEADER</a></tt> <tt class="py-op">%</tt> <tt id="link-369" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-369', 'name', 'link-206');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"> <tt class="py-comment"># Write an entry for each normal var:</tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">normal_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</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">var_doc</tt><tt class="py-op">.</tt><tt id="link-370" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-370', 'value', 'link-126');">value</a></tt><tt class="py-op">,</tt> <tt id="link-371" class="py-name"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-371', 'PropertyDoc', 'link-362');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-372" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_property_list_line" class="py-name" href="#" onclick="return doclink('link-372', 'write_property_list_line', 'link-363');">write_property_list_line</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-373" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.write_var_list_line" class="py-name" href="#" onclick="return doclink('link-373', 'write_var_list_line', 'link-364');">write_var_list_line</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"> <tt class="py-comment"># Write a subsection for inherited vars:</tt> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-374" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.write_var_inheritance_list()=epydoc.docwriter.latex.LatexWriter-class.html#write_var_inheritance_list"><a title="epydoc.docwriter.latex.LatexWriter.write_var_inheritance_list" class="py-name" href="#" onclick="return doclink('link-374', 'write_var_inheritance_list', 'link-374');">write_var_inheritance_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">)</tt> </tt>
</div><a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_var_inheritance_list"></a><div id="LatexWriter.write_var_inheritance_list-def"><a name="L960"></a><tt class="py-lineno"> 960</tt> <a class="py-toggle" href="#" id="LatexWriter.write_var_inheritance_list-toggle" onclick="return toggle('LatexWriter.write_var_inheritance_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_var_inheritance_list">write_var_inheritance_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">listed_inh_vars</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_var_inheritance_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_var_inheritance_list-expanded"><a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-375" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-375', 'mro', 'link-231');">mro</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"> <tt class="py-comment">#if str(base.canonical_name) == 'object': continue</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var_docs</tt> <tt class="py-op">=</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">[</tt><tt class="py-name">base</tt><tt class="py-op">]</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</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">_public_filter</tt><tt class="py-op">:</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"> <tt class="py-name">var_docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-376" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-376', 'v', 'link-245');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-377" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-377', 'v', 'link-245');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt> <tt class="py-keyword">if</tt> <tt id="link-378" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-378', 'v', 'link-245');">v</a></tt><tt class="py-op">.</tt><tt id="link-379" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-379', 'is_public', 'link-248');">is_public</a></tt><tt class="py-op">]</tt> </tt>
<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'Inherited from %s'</tt> <tt class="py-op">%</tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"> <tt id="link-380" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-380', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-381" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-381', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</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">_crossref</tt> <tt class="py-keyword">and</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt><tt class="py-op">:</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-string">' \\textit{(Section \\ref{%s})}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-382" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-382', 'label', 'link-111');">label</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-383" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._VAR_GROUP_HEADER" class="py-name" href="#" onclick="return doclink('link-383', '_VAR_GROUP_HEADER', 'link-348');">_VAR_GROUP_HEADER</a></tt> <tt class="py-op">%</tt> <tt class="py-name">hdr</tt><tt class="py-op">)</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\multicolumn{2}{|p{\\varwidth}|}{'</tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"> <tt class="py-string">'\\raggedright %s}\\\\\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"> <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-string">'%s'</tt> <tt class="py-op">%</tt> <tt id="link-384" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-384', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-385" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-385', 'name', 'link-206');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_var_list_line"></a><div id="LatexWriter.write_var_list_line-def"><a name="L981"></a><tt class="py-lineno"> 981</tt> <a class="py-toggle" href="#" id="LatexWriter.write_var_list_line-toggle" onclick="return toggle('LatexWriter.write_var_list_line');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_var_list_line">write_var_list_line</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_var_list_line-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_var_list_line-expanded"><a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\raggedright '</tt><tt class="py-op">)</tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt id="link-386" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-386', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-387" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-387', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">nbsp</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">breakany</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' & '</tt><tt class="py-op">)</tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> <tt class="py-name">has_descr</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-388" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-388', 'descr', 'link-112');">descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-389" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-389', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-name">has_type</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-390" 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-390', 'type_descr', 'link-390');">type_descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-391" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-391', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> <tt class="py-name">has_value</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-392" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-392', 'value', 'link-126');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-393" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-393', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_type</tt> <tt class="py-keyword">or</tt> <tt class="py-name">has_value</tt><tt class="py-op">:</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\raggedright '</tt><tt class="py-op">)</tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_descr</tt><tt class="py-op">:</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-394" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-394', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-395" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-395', 'descr', 'link-112');">descr</a></tt><tt class="py-op">,</tt> <tt class="py-number">10</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 class="py-op">)</tt> </tt>
<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_type</tt> <tt class="py-keyword">or</tt> <tt class="py-name">has_value</tt><tt class="py-op">:</tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_value</tt><tt class="py-op">:</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\textbf{Value:} \n{\\tt %s}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-396" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-396', 'value', 'link-126');">value</a></tt><tt class="py-op">.</tt><tt id="link-397" class="py-name"><a title="epydoc.apidoc.ValueDoc.summary_pyval_repr" class="py-name" href="#" onclick="return doclink('link-397', 'summary_pyval_repr', 'link-339');">summary_pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-398" class="py-name"><a title="epydoc.markup.ConcatenatedDocstring.to_latex
epydoc.markup.ParsedDocstring.to_latex
epydoc.markup.epytext.ParsedEpytextDocstring.to_latex
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_latex
epydoc.markup.restructuredtext.ParsedRstDocstring.to_latex" class="py-name" href="#" onclick="return doclink('link-398', 'to_latex', 'link-340');">to_latex</a></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="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_type</tt><tt class="py-op">:</tt> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> <tt class="py-name">ptype</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-399" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-399', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-400" 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-400', 'type_descr', 'link-390');">type_descr</a></tt><tt class="py-op">,</tt> <tt class="py-number">12</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="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'%s{\\it (type=%s)}'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">12</tt><tt class="py-op">,</tt> <tt class="py-name">ptype</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'&\\\\\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_property_list_line"></a><div id="LatexWriter.write_property_list_line-def"><a name="L1002"></a><tt class="py-lineno">1002</tt> <a class="py-toggle" href="#" id="LatexWriter.write_property_list_line-toggle" onclick="return toggle('LatexWriter.write_property_list_line');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_property_list_line">write_property_list_line</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_property_list_line-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_property_list_line-expanded"><a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"> <tt class="py-name">prop_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-401" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-401', 'value', 'link-126');">value</a></tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\raggedright '</tt><tt class="py-op">)</tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt id="link-402" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-402', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-403" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-403', 'name', 'link-206');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">nbsp</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">breakany</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' & '</tt><tt class="py-op">)</tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-name">has_descr</tt> <tt class="py-op">=</tt> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-404" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-404', 'descr', 'link-112');">descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-405" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-405', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-name">has_type</tt> <tt class="py-op">=</tt> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-406" 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-406', 'type_descr', 'link-390');">type_descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-407" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-407', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_descr</tt> <tt class="py-keyword">or</tt> <tt class="py-name">has_type</tt><tt class="py-op">:</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\raggedright '</tt><tt class="py-op">)</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_descr</tt><tt class="py-op">:</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-408" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-408', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-409" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-409', 'descr', 'link-112');">descr</a></tt><tt class="py-op">,</tt> <tt class="py-number">10</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 class="py-op">)</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_type</tt><tt class="py-op">:</tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">has_type</tt><tt class="py-op">:</tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> <tt class="py-name">ptype</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-410" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-410', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-411" 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-411', 'type_descr', 'link-390');">type_descr</a></tt><tt class="py-op">,</tt> <tt class="py-number">12</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="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'%s{\\it (type=%s)}'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-number">12</tt><tt class="py-op">,</tt> <tt class="py-name">ptype</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> <tt class="py-comment"># [xx] List the fget/fset/fdel functions?</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'&\\\\\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\\cline{1-2}\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Standard Fields</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> <tt class="py-comment"># Copied from HTMLWriter:</tt> </tt>
<a name="LatexWriter.write_standard_fields"></a><div id="LatexWriter.write_standard_fields-def"><a name="L1026"></a><tt class="py-lineno">1026</tt> <a class="py-toggle" href="#" id="LatexWriter.write_standard_fields-toggle" onclick="return toggle('LatexWriter.write_standard_fields');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_standard_fields">write_standard_fields</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_standard_fields-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_standard_fields-expanded"><a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-name">fields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"> <tt class="py-name">field_values</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"> <tt class="py-comment">#if _sort_fields: fields = STANDARD_FIELD_NAMES [XX]</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt> <tt id="link-412" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-412', 'arg', 'link-275');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-413" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-413', 'descr', 'link-112');">descr</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-414" class="py-name" targets="Variable epydoc.apidoc.APIDoc.metadata=epydoc.apidoc.APIDoc-class.html#metadata"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-414', 'metadata', 'link-414');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">field_values</tt><tt class="py-op">:</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"> <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">field</tt><tt class="py-op">)</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">takes_arg</tt><tt class="py-op">:</tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"> <tt class="py-name">subfields</tt> <tt class="py-op">=</tt> <tt class="py-name">field_values</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"> <tt class="py-name">subfields</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt id="link-415" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-415', 'arg', 'link-275');">arg</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">append</tt><tt class="py-op">(</tt><tt id="link-416" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-416', 'descr', 'link-112');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"> <tt class="py-name">field_values</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">field</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">append</tt><tt class="py-op">(</tt><tt id="link-417" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-417', 'descr', 'link-112');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">fields</tt><tt class="py-op">:</tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">takes_arg</tt><tt class="py-op">:</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-418" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-418', 'arg', 'link-275');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">descrs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">field_values</tt><tt class="py-op">[</tt><tt class="py-name">field</tt><tt class="py-op">]</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="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-419" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_standard_field()=epydoc.docwriter.html.HTMLWriter-class.html#write_standard_field,Method epydoc.docwriter.latex.LatexWriter.write_standard_field()=epydoc.docwriter.latex.LatexWriter-class.html#write_standard_field"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_field
epydoc.docwriter.latex.LatexWriter.write_standard_field" class="py-name" href="#" onclick="return doclink('link-419', 'write_standard_field', 'link-419');">write_standard_field</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">,</tt> <tt class="py-name">descrs</tt><tt class="py-op">,</tt> <tt id="link-420" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-420', 'arg', 'link-275');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-421" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_field
epydoc.docwriter.latex.LatexWriter.write_standard_field" class="py-name" href="#" onclick="return doclink('link-421', 'write_standard_field', 'link-419');">write_standard_field</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">,</tt> <tt class="py-name">field_values</tt><tt class="py-op">[</tt><tt class="py-name">field</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_standard_field"></a><div id="LatexWriter.write_standard_field-def"><a name="L1049"></a><tt class="py-lineno">1049</tt> <a class="py-toggle" href="#" id="LatexWriter.write_standard_field-toggle" onclick="return toggle('LatexWriter.write_standard_field');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_standard_field">write_standard_field</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">field</tt><tt class="py-op">,</tt> <tt class="py-param">descrs</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_standard_field-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_standard_field-expanded"><a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"> <tt class="py-name">singular</tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">singular</tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"> <tt class="py-name">plural</tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">plural</tt> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-422" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-422', 'arg', 'link-275');">arg</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"> <tt class="py-name">singular</tt> <tt class="py-op">+=</tt> <tt class="py-string">' (%s)'</tt> <tt class="py-op">%</tt> <tt id="link-423" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-423', 'arg', 'link-275');">arg</a></tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"> <tt class="py-name">plural</tt> <tt class="py-op">+=</tt> <tt class="py-string">' (%s)'</tt> <tt class="py-op">%</tt> <tt id="link-424" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-424', 'arg', 'link-275');">arg</a></tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-425" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._descrlist" class="py-name" href="#" onclick="return doclink('link-425', '_descrlist', 'link-148');">_descrlist</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-426" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.docstring_to_latex" class="py-name" href="#" onclick="return doclink('link-426', 'docstring_to_latex', 'link-114');">docstring_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">descrs</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">singular</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">plural</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">short</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"> </tt>
<a name="LatexWriter._descrlist"></a><div id="LatexWriter._descrlist-def"><a name="L1058"></a><tt class="py-lineno">1058</tt> <a class="py-toggle" href="#" id="LatexWriter._descrlist-toggle" onclick="return toggle('LatexWriter._descrlist');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#_descrlist">_descrlist</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">singular</tt><tt class="py-op">,</tt> <tt class="py-param">plural</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">short</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter._descrlist-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter._descrlist-expanded"><a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">plural</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">plural</tt> <tt class="py-op">=</tt> <tt class="py-name">singular</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</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">items</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-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</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">items</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt> <tt class="py-keyword">and</tt> <tt class="py-name">singular</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="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\textbf{%s:} %s\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">singular</tt><tt class="py-op">,</tt> <tt class="py-name">items</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="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">short</tt><tt class="py-op">:</tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'\\textbf{%s:}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">plural</tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> <tt class="py-name">items</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-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</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="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</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">items</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n\n'</tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'\\textbf{%s:}\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">plural</tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\\begin{quote}\n'</tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">' \\begin{itemize}\n\n \item\n'</tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">' \\setlength{\\parskip}{0.6ex}\n'</tt> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n\n \item '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">items</tt><tt class="py-op">)</tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n\n\\end{itemize}\n\n\\end{quote}\n\n'</tt> </tt>
</div><a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Docstring -> LaTeX Conversion</tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"> <tt class="py-comment"># We only need one linker, since we don't use context:</tt> </tt>
<a name="LatexWriter._LatexDocstringLinker"></a><div id="LatexWriter._LatexDocstringLinker-def"><a name="L1081"></a><tt class="py-lineno">1081</tt> <a class="py-toggle" href="#" id="LatexWriter._LatexDocstringLinker-toggle" onclick="return toggle('LatexWriter._LatexDocstringLinker');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker-class.html">_LatexDocstringLinker</a><tt class="py-op">(</tt><tt class="py-base-class">markup</tt><tt class="py-op">.</tt><tt class="py-base-class">DocstringLinker</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter._LatexDocstringLinker-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter._LatexDocstringLinker-expanded"><a name="LatexWriter._LatexDocstringLinker.translate_indexterm"></a><div id="LatexWriter._LatexDocstringLinker.translate_indexterm-def"><a name="L1082"></a><tt class="py-lineno">1082</tt> <a class="py-toggle" href="#" id="LatexWriter._LatexDocstringLinker.translate_indexterm-toggle" onclick="return toggle('LatexWriter._LatexDocstringLinker.translate_indexterm');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker-class.html#translate_indexterm">translate_indexterm</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">indexterm</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter._LatexDocstringLinker.translate_indexterm-collapsed" style="display:none;" pad="++++" indent="++++++++++++++++"></div><div id="LatexWriter._LatexDocstringLinker.translate_indexterm-expanded"><a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-name">indexstr</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">r'["!|@]'</tt><tt class="py-op">,</tt> <tt class="py-string">r'"\1'</tt><tt class="py-op">,</tt> <tt id="link-427" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.indexterm" class="py-name" href="#" onclick="return doclink('link-427', 'indexterm', 'link-107');">indexterm</a></tt><tt class="py-op">.</tt><tt id="link-428" class="py-name"><a title="epydoc.markup.ConcatenatedDocstring.to_latex
epydoc.markup.ParsedDocstring.to_latex
epydoc.markup.epytext.ParsedEpytextDocstring.to_latex
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_latex
epydoc.markup.restructuredtext.ParsedRstDocstring.to_latex" class="py-name" href="#" onclick="return doclink('link-428', 'to_latex', 'link-340');">to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'\\index{%s}\\textit{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">indexstr</tt><tt class="py-op">,</tt> <tt class="py-name">indexstr</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="LatexWriter._LatexDocstringLinker.translate_identifier_xref"></a><div id="LatexWriter._LatexDocstringLinker.translate_identifier_xref-def"><a name="L1085"></a><tt class="py-lineno">1085</tt> <a class="py-toggle" href="#" id="LatexWriter._LatexDocstringLinker.translate_identifier_xref-toggle" onclick="return toggle('LatexWriter._LatexDocstringLinker.translate_identifier_xref');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker-class.html#translate_identifier_xref">translate_identifier_xref</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">identifier</tt><tt class="py-op">,</tt> <tt class="py-param">label</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="LatexWriter._LatexDocstringLinker.translate_identifier_xref-collapsed" style="display:none;" pad="++++" indent="++++++++++++++++"></div><div id="LatexWriter._LatexDocstringLinker.translate_identifier_xref-expanded"><a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-429" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-429', 'label', 'link-111');">label</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt id="link-430" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-430', 'label', 'link-111');">label</a></tt> <tt class="py-op">=</tt> <tt id="link-431" 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-431', 'markup', 'link-9');">markup</a></tt><tt class="py-op">.</tt><tt id="link-432" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-432', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">)</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\texttt{%s}'</tt> <tt class="py-op">%</tt> <tt id="link-433" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-433', 'label', 'link-111');">label</a></tt> </tt>
</div></div><a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt id="link-434" class="py-name" targets="Variable epydoc.docwriter.latex.LatexWriter._docstring_linker=epydoc.docwriter.latex.LatexWriter-class.html#_docstring_linker"><a title="epydoc.docwriter.latex.LatexWriter._docstring_linker" class="py-name" href="#" onclick="return doclink('link-434', '_docstring_linker', 'link-434');">_docstring_linker</a></tt> <tt class="py-op">=</tt> <tt id="link-435" class="py-name" targets="Class epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker=epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker-class.html"><a title="epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker" class="py-name" href="#" onclick="return doclink('link-435', '_LatexDocstringLinker', 'link-435');">_LatexDocstringLinker</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.docstring_to_latex"></a><div id="LatexWriter.docstring_to_latex-def"><a name="L1090"></a><tt class="py-lineno">1090</tt> <a class="py-toggle" href="#" id="LatexWriter.docstring_to_latex-toggle" onclick="return toggle('LatexWriter.docstring_to_latex');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#docstring_to_latex">docstring_to_latex</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docstring</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">breakany</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.docstring_to_latex-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.docstring_to_latex-expanded"><a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-436" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-436', 'docstring', 'link-261');">docstring</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 class="py-string">''</tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-437" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-437', 'docstring', 'link-261');">docstring</a></tt><tt class="py-op">.</tt><tt id="link-438" class="py-name"><a title="epydoc.markup.ConcatenatedDocstring.to_latex
epydoc.markup.ParsedDocstring.to_latex
epydoc.markup.epytext.ParsedEpytextDocstring.to_latex
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_latex
epydoc.markup.restructuredtext.ParsedRstDocstring.to_latex" class="py-name" href="#" onclick="return doclink('link-438', 'to_latex', 'link-340');">to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-439" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter._docstring_linker" class="py-name" href="#" onclick="return doclink('link-439', '_docstring_linker', 'link-434');">_docstring_linker</a></tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-name">indent</tt><tt class="py-op">,</tt> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> <tt class="py-name">hyperref</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_hyperref</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Helpers</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="LatexWriter.write_header"></a><div id="LatexWriter.write_header-def"><a name="L1099"></a><tt class="py-lineno">1099</tt> <a class="py-toggle" href="#" id="LatexWriter.write_header-toggle" onclick="return toggle('LatexWriter.write_header');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_header">write_header</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">where</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_header-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_header-expanded"><a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'%\n% API Documentation'</tt><tt class="py-op">)</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</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">_prj_name</tt><tt class="py-op">:</tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' for %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</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">where</tt><tt class="py-op">,</tt> <tt id="link-440" class="py-name" targets="Class epydoc.apidoc.APIDoc=epydoc.apidoc.APIDoc-class.html"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-440', 'APIDoc', 'link-440');">APIDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n%% %s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-441" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.doc_kind
epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind
epydoc.docwriter.latex.LatexWriter.doc_kind" class="py-name" href="#" onclick="return doclink('link-441', 'doc_kind', 'link-109');">doc_kind</a></tt><tt class="py-op">(</tt><tt class="py-name">where</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">where</tt><tt class="py-op">.</tt><tt id="link-442" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-442', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n%% %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">where</tt><tt class="py-op">)</tt> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n%%\n%% Generated by epydoc %s\n'</tt> <tt class="py-op">%</tt> <tt id="link-443" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-443', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-444" class="py-name"><a title="epydoc.__version__" class="py-name" href="#" onclick="return doclink('link-444', '__version__', 'link-96');">__version__</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'%% [%s]\n%%\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">asctime</tt><tt class="py-op">(</tt><tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">localtime</tt><tt class="py-op">(</tt><tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</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><a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.write_start_of"></a><div id="LatexWriter.write_start_of-def"><a name="L1109"></a><tt class="py-lineno">1109</tt> <a class="py-toggle" href="#" id="LatexWriter.write_start_of-toggle" onclick="return toggle('LatexWriter.write_start_of');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#write_start_of">write_start_of</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">section_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.write_start_of-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.write_start_of-expanded"><a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt> <tt class="py-op">+</tt> <tt class="py-number">75</tt><tt class="py-op">*</tt><tt class="py-string">'%'</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'%%'</tt> <tt class="py-op">+</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-number">71</tt><tt class="py-op">-</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">section_name</tt><tt class="py-op">)</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-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt> </tt>
<a name="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">section_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-number">72</tt><tt class="py-op">-</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">section_name</tt><tt class="py-op">)</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-op">*</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-string">'%%\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-number">75</tt><tt class="py-op">*</tt><tt class="py-string">'%'</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.section"></a><div id="LatexWriter.section-def"><a name="L1116"></a><tt class="py-lineno">1116</tt> <a class="py-toggle" href="#" id="LatexWriter.section-toggle" onclick="return toggle('LatexWriter.section');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#section">section</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.section-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.section-expanded"><a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"> <tt class="py-name">sec</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-445" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.SECTIONS" class="py-name" href="#" onclick="return doclink('link-445', 'SECTIONS', 'link-17');">SECTIONS</a></tt><tt class="py-op">[</tt><tt class="py-name">depth</tt><tt class="py-op">+</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_top_section</tt><tt class="py-op">]</tt> </tt>
<a name="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'%s\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">sec</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt id="link-446" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-446', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt id="link-447" 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-447', 'title', 'link-447');">title</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.sectionstar"></a><div id="LatexWriter.sectionstar-def"><a name="L1120"></a><tt class="py-lineno">1120</tt> <a class="py-toggle" href="#" id="LatexWriter.sectionstar-toggle" onclick="return toggle('LatexWriter.sectionstar');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#sectionstar">sectionstar</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.sectionstar-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.sectionstar-expanded"><a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"> <tt class="py-name">sec</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">STARSECTIONS</tt><tt class="py-op">[</tt><tt class="py-name">depth</tt><tt class="py-op">+</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_top_section</tt><tt class="py-op">]</tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'%s\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">sec</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt id="link-448" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-448', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt id="link-449" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-449', 'title', 'link-447');">title</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.doc_kind"></a><div id="LatexWriter.doc_kind-def"><a name="L1124"></a><tt class="py-lineno">1124</tt> <a class="py-toggle" href="#" id="LatexWriter.doc_kind-toggle" onclick="return toggle('LatexWriter.doc_kind');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#doc_kind">doc_kind</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.doc_kind-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.doc_kind-expanded"><a name="L1125"></a><tt class="py-lineno">1125</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">doc</tt><tt class="py-op">,</tt> <tt id="link-450" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-450', 'ModuleDoc', 'link-42');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-451" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.is_package=epydoc.apidoc.ModuleDoc-class.html#is_package"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-451', 'is_package', 'link-451');">is_package</a></tt> <tt class="py-op">==</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Package'</tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-452" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-452', 'ModuleDoc', 'link-42');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-453" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-453', 'canonical_name', 'link-44');">canonical_name</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">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'script'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Script'</tt> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</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">doc</tt><tt class="py-op">,</tt> <tt id="link-454" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-454', 'ModuleDoc', 'link-42');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Module'</tt> </tt>
<a name="L1132"></a><tt class="py-lineno">1132</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">doc</tt><tt class="py-op">,</tt> <tt id="link-455" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-455', 'ClassDoc', 'link-26');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Class'</tt> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</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">doc</tt><tt class="py-op">,</tt> <tt id="link-456" class="py-name" targets="Class epydoc.apidoc.ClassMethodDoc=epydoc.apidoc.ClassMethodDoc-class.html"><a title="epydoc.apidoc.ClassMethodDoc" class="py-name" href="#" onclick="return doclink('link-456', 'ClassMethodDoc', 'link-456');">ClassMethodDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Class Method'</tt> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</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">doc</tt><tt class="py-op">,</tt> <tt id="link-457" class="py-name" targets="Class epydoc.apidoc.StaticMethodDoc=epydoc.apidoc.StaticMethodDoc-class.html"><a title="epydoc.apidoc.StaticMethodDoc" class="py-name" href="#" onclick="return doclink('link-457', 'StaticMethodDoc', 'link-457');">StaticMethodDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Static Method'</tt> </tt>
<a name="L1138"></a><tt class="py-lineno">1138</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">doc</tt><tt class="py-op">,</tt> <tt id="link-458" class="py-name" targets="Class epydoc.apidoc.RoutineDoc=epydoc.apidoc.RoutineDoc-class.html"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-458', 'RoutineDoc', 'link-458');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1139"></a><tt class="py-lineno">1139</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">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-459" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-459', 'container', 'link-237');">container</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-460" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-460', 'ClassDoc', 'link-26');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Method'</tt> </tt>
<a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Function'</tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Variable'</tt> </tt>
</div><a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.indexterm"></a><div id="LatexWriter.indexterm-def"><a name="L1146"></a><tt class="py-lineno">1146</tt> <a class="py-toggle" href="#" id="LatexWriter.indexterm-toggle" onclick="return toggle('LatexWriter.indexterm');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#indexterm">indexterm</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">pos</tt><tt class="py-op">=</tt><tt class="py-string">'only'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.indexterm-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.indexterm-expanded"><a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> <tt class="py-docstring">"""Mark a term or section for inclusion in the index."""</tt> </tt>
<a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_index</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</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">doc</tt><tt class="py-op">,</tt> <tt id="link-461" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-461', 'RoutineDoc', 'link-458');">RoutineDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_index_functions</tt><tt class="py-op">:</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"> <tt class="py-name">pieces</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"> <tt class="py-keyword">while</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="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-462" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-462', 'canonical_name', 'link-44');">canonical_name</a></tt> <tt class="py-op">==</tt> <tt id="link-463" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-463', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> <tt class="py-comment"># Give up.</tt> </tt>
<a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"> <tt class="py-name">pieces</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'%s \\textit{(%s)}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-464" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-464', 'plaintext_to_latex', 'link-12');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt><tt class="py-op">%</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-465" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-465', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-466" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.doc_kind
epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind
epydoc.docwriter.latex.LatexWriter.doc_kind" class="py-name" href="#" onclick="return doclink('link-466', 'doc_kind', 'link-109');">doc_kind</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-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1159"></a><tt class="py-lineno">1159</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 class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-467" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-467', 'container', 'link-237');">container</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt> <tt class="py-op">==</tt> <tt id="link-468" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-468', 'UNKNOWN', 'link-113');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> <tt class="py-comment"># Give up.</tt> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"> </tt>
<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> <tt class="py-name">pieces</tt><tt class="py-op">.</tt><tt class="py-name">reverse</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">pos</tt> <tt class="py-op">==</tt> <tt class="py-string">'only'</tt><tt class="py-op">:</tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\index{%s}\n'</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-name">pieces</tt><tt class="py-op">)</tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">pos</tt> <tt class="py-op">==</tt> <tt class="py-string">'start'</tt><tt class="py-op">:</tt> </tt>
<a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\index{%s|(}\n'</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-name">pieces</tt><tt class="py-op">)</tt> </tt>
<a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">pos</tt> <tt class="py-op">==</tt> <tt class="py-string">'end'</tt><tt class="py-op">:</tt> </tt>
<a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\index{%s|)}\n'</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-name">pieces</tt><tt class="py-op">)</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">AssertionError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad index position %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">pos</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.label"></a><div id="LatexWriter.label-def"><a name="L1173"></a><tt class="py-lineno">1173</tt> <a class="py-toggle" href="#" id="LatexWriter.label-toggle" onclick="return toggle('LatexWriter.label');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#label">label</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LatexWriter.label-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.label-expanded"><a name="L1174"></a><tt class="py-lineno">1174</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">doc</tt><tt class="py-op">.</tt><tt id="link-469" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-469', 'canonical_name', 'link-44');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"> <tt class="py-comment">#: Map the Python encoding representation into mismatching LaTeX ones.</tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-470" class="py-name" targets="Variable epydoc.docwriter.latex.LatexWriter.latex_encodings=epydoc.docwriter.latex.LatexWriter-class.html#latex_encodings"><a title="epydoc.docwriter.latex.LatexWriter.latex_encodings" class="py-name" href="#" onclick="return doclink('link-470', 'latex_encodings', 'link-470');">latex_encodings</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"> <tt class="py-string">'utf-8'</tt><tt class="py-op">:</tt> <tt class="py-string">'utf8'</tt><tt class="py-op">,</tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"> </tt>
<a name="LatexWriter.get_latex_encoding"></a><div id="LatexWriter.get_latex_encoding-def"><a name="L1181"></a><tt class="py-lineno">1181</tt> <a class="py-toggle" href="#" id="LatexWriter.get_latex_encoding-toggle" onclick="return toggle('LatexWriter.get_latex_encoding');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.latex.LatexWriter-class.html#get_latex_encoding">get_latex_encoding</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="LatexWriter.get_latex_encoding-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="LatexWriter.get_latex_encoding-expanded"><a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"><tt class="py-docstring"> @return: The LaTeX representation of the selected encoding.</tt> </tt>
<a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"> <tt class="py-name">enc</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">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-471" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.latex_encodings" class="py-name" href="#" onclick="return doclink('link-471', 'latex_encodings', 'link-470');">latex_encodings</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">enc</tt><tt class="py-op">,</tt> <tt class="py-name">enc</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1188"></a><tt class="py-lineno">1188</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:08 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>
