<?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.xlink</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 xlink
</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.xlink-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.docwriter.xlink-module.html">Module epydoc.docwriter.xlink</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-docstring">A Docutils_ interpreted text role for cross-API reference support.</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring">This module allows a Docutils_ document to refer to elements defined in</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-docstring">external API documentation. It is possible to refer to many external API</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-docstring">from the same document.</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-docstring">Each API documentation is assigned a new interpreted text role: using such</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">interpreted text, an user can specify an object name inside an API</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring">documentation. The system will convert such text into an url and generate a</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">reference to it. For example, if the API ``db`` is defined, being a database</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring">package, then a certain method may be referred as::</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring"> :db:`Connection.cursor()`</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring">To define a new API, an *index file* must be provided. This file contains</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">a mapping from the object name to the URL part required to resolve such object.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">Index file</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">----------</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring">Each line in the the index file describes an object.</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring">Each line contains the fully qualified name of the object and the URL at which</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring">the documentation is located. The fields are separated by a ``<tab>``</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring">character.</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring">The URL's in the file are relative from the documentation root: the system can</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring">be configured to add a prefix in front of each returned URL.</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring">Allowed names</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring">-------------</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring">When a name is used in an API text role, it is split over any *separator*.</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring">The separators defined are '``.``', '``::``', '``->``'. All the text from the</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring">first noise char (neither a separator nor alphanumeric or '``_``') is</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring">discarded. The same algorithm is applied when the index file is read.</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring">First the sequence of name parts is looked for in the provided index file.</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring">If no matching name is found, a partial match against the trailing part of the</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring">names in the index is performed. If no object is found, or if the trailing part</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring">of the name may refer to many objects, a warning is issued and no reference</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring">is created.</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring">Configuration</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring">-------------</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring">This module provides the class `ApiLinkReader` a replacement for the Docutils</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring">standalone reader. Such reader specifies the settings required for the</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring">API canonical roles configuration. The same command line options are exposed by</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring">Epydoc.</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring">The script ``apirst2html.py`` is a frontend for the `ApiLinkReader` reader.</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring">API Linking Options::</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> --external-api=NAME</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> Define a new API document. A new interpreted text</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> role NAME will be added.</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> --external-api-file=NAME:FILENAME</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> Use records in FILENAME to resolve objects in the API</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> named NAME.</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> --external-api-root=NAME:STRING</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> Use STRING as prefix for the URL generated from the</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> API NAME.</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring">.. _Docutils: http://docutils.sourceforge.net/</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-comment"># $Id: xlink.py 1586 2007-03-14 01:53:42Z dvarrazzo $</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-0" class="py-name" targets="Variable epydoc.__version__=epydoc-module.html#__version__"><a title="epydoc.__version__" class="py-name" href="#" onclick="return doclink('link-0', '__version__', 'link-0');">__version__</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"$Revision: 1586 $"</tt><tt class="py-op">[</tt><tt class="py-number">11</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="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt id="link-1" class="py-name" targets="Variable epydoc.__author__=epydoc-module.html#__author__"><a title="epydoc.__author__" class="py-name" href="#" onclick="return doclink('link-1', '__author__', 'link-1');">__author__</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"Daniele Varrazzo"</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-name">__copyright__</tt> <tt class="py-op">=</tt> <tt class="py-string">"Copyright (C) 2007 by Daniele Varrazzo"</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'reStructuredText en'</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">optparse</tt> <tt class="py-keyword">import</tt> <tt class="py-name">OptionValueError</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-2', 'epydoc', 'link-2');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" 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-3', 'log', 'link-3');">log</a></tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> </tt>
<a name="UrlGenerator"></a><div id="UrlGenerator-def"><a name="L82"></a><tt class="py-lineno"> 82</tt> <a class="py-toggle" href="#" id="UrlGenerator-toggle" onclick="return toggle('UrlGenerator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.UrlGenerator-class.html">UrlGenerator</a><tt class="py-op">:</tt> </tt>
</div><div id="UrlGenerator-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UrlGenerator-expanded"><a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> Generate URL from an object name.</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="UrlGenerator.IndexAmbiguous"></a><div id="UrlGenerator.IndexAmbiguous-def"><a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="UrlGenerator.IndexAmbiguous-toggle" onclick="return toggle('UrlGenerator.IndexAmbiguous');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.UrlGenerator.IndexAmbiguous-class.html">IndexAmbiguous</a><tt class="py-op">(</tt><tt class="py-base-class">IndexError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UrlGenerator.IndexAmbiguous-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="UrlGenerator.IndexAmbiguous-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> The name looked for is ambiguous</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt>
<a name="UrlGenerator.get_url"></a><div id="UrlGenerator.get_url-def"><a name="L91"></a><tt class="py-lineno"> 91</tt> <a class="py-toggle" href="#" id="UrlGenerator.get_url-toggle" onclick="return toggle('UrlGenerator.get_url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.UrlGenerator-class.html#get_url">get_url</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-op">:</tt> </tt>
</div><div id="UrlGenerator.get_url-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="UrlGenerator.get_url-expanded"><a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-docstring">"""Look for a name and return the matching URL documentation.</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> First look for a fully qualified name. If not found, try with partial</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> name.</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> If no url exists for the given object, return `None`.</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"> `name` : `str`</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"> the name to look for</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> :return: the URL that can be used to reach the `name` documentation.</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> `None` if no such URL exists.</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: `str`</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-docstring"> :Exceptions:</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"><tt class="py-docstring"> - `IndexError`: no object found with `name`</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"><tt class="py-docstring"> - `DocUrlGenerator.IndexAmbiguous` : more than one object found with</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"> a non-fully qualified name; notice that this is an ``IndexError``</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> subclass</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt> </tt>
</div><a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> </tt>
<a name="UrlGenerator.get_canonical_name"></a><div id="UrlGenerator.get_canonical_name-def"><a name="L115"></a><tt class="py-lineno">115</tt> <a class="py-toggle" href="#" id="UrlGenerator.get_canonical_name-toggle" onclick="return toggle('UrlGenerator.get_canonical_name');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.UrlGenerator-class.html#get_canonical_name">get_canonical_name</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-op">:</tt> </tt>
</div><div id="UrlGenerator.get_canonical_name-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="UrlGenerator.get_canonical_name-expanded"><a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"> Convert an object name into a canonical name.</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> the canonical name of an object is a tuple of strings containing its</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> name fragments, splitted on any allowed separator ('``.``', '``::``',</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"> '``->``').</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"> Noise such parenthesis to indicate a function is discarded.</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"> `name` : `str`</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> an object name, such as ``os.path.prefix()`` or ``lib::foo::bar``</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"> :return: the fully qualified name such ``('os', 'path', 'prefix')`` and</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> ``('lib', 'foo', 'bar')``</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: `tuple` of `str`</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt class="py-name">rv</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Variable epydoc.docwriter.xlink.UrlGenerator._SEP_RE=epydoc.docwriter.xlink.UrlGenerator-class.html#_SEP_RE"><a title="epydoc.docwriter.xlink.UrlGenerator._SEP_RE" class="py-name" href="#" onclick="return doclink('link-4', '_SEP_RE', 'link-4');">_SEP_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">finditer</tt><tt class="py-op">(</tt><tt id="link-5" 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-5', 'name', 'link-5');">name</a></tt><tt class="py-op">)</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">groups</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">groups</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">groups</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</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="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-name">rv</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">groups</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="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">groups</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</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="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">rv</tt><tt class="py-op">)</tt> </tt>
</div><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"> <tt id="link-6" class="py-name"><a title="epydoc.docwriter.xlink.UrlGenerator._SEP_RE" class="py-name" href="#" onclick="return doclink('link-6', '_SEP_RE', 'link-4');">_SEP_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r"""(?x)</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-string"> # Tokenize the input into keyword, separator, noise</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-string"> ([a-zA-Z0-9_]+) | # A keyword is a alphanum word</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-string"> ( \. | \:\: | \-\> ) | # These are the allowed separators</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-string"> (.) # If it doesn't fit, it's noise.</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-string"> # Matching a single noise char is enough, because it</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-string"> # is used to break the tokenization as soon as some noise</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-string"> # is found.</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">)</tt> </tt>
</div><a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> </tt>
<a name="VoidUrlGenerator"></a><div id="VoidUrlGenerator-def"><a name="L154"></a><tt class="py-lineno">154</tt> <a class="py-toggle" href="#" id="VoidUrlGenerator-toggle" onclick="return toggle('VoidUrlGenerator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.VoidUrlGenerator-class.html">VoidUrlGenerator</a><tt class="py-op">(</tt><tt class="py-base-class">UrlGenerator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="VoidUrlGenerator-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="VoidUrlGenerator-expanded"><a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-docstring"> Don't actually know any url, but don't report any error.</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-docstring"> Useful if an index file is not available, but a document linking to it</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-docstring"> is to be generated, and warnings are to be avoided.</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"><tt class="py-docstring"> Don't report any object as missing, Don't return any url anyway.</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="VoidUrlGenerator.get_url"></a><div id="VoidUrlGenerator.get_url-def"><a name="L163"></a><tt class="py-lineno">163</tt> <a class="py-toggle" href="#" id="VoidUrlGenerator.get_url-toggle" onclick="return toggle('VoidUrlGenerator.get_url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.VoidUrlGenerator-class.html#get_url">get_url</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-op">:</tt> </tt>
</div><div id="VoidUrlGenerator.get_url-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="VoidUrlGenerator.get_url-expanded"><a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div></div><a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"> </tt>
<a name="DocUrlGenerator"></a><div id="DocUrlGenerator-def"><a name="L167"></a><tt class="py-lineno">167</tt> <a class="py-toggle" href="#" id="DocUrlGenerator-toggle" onclick="return toggle('DocUrlGenerator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.DocUrlGenerator-class.html">DocUrlGenerator</a><tt class="py-op">(</tt><tt class="py-base-class">UrlGenerator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocUrlGenerator-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="DocUrlGenerator-expanded"><a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> Read a *documentation index* and generate URL's for it.</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="DocUrlGenerator.__init__"></a><div id="DocUrlGenerator.__init__-def"><a name="L171"></a><tt class="py-lineno">171</tt> <a class="py-toggle" href="#" id="DocUrlGenerator.__init__-toggle" onclick="return toggle('DocUrlGenerator.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.DocUrlGenerator-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocUrlGenerator.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocUrlGenerator.__init__-expanded"><a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exact_matches</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-string"> A map from an object fully qualified name to its URL.</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"><tt class="py-string"> Values are both the name as tuple of fragments and as read from the</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-string"> records (see `load_records()`), mostly to help `_partial_names` to</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-string"> perform lookup for unambiguous names.</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_partial_names</tt><tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"><tt class="py-string"> A map from partial names to the fully qualified names they may refer.</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"><tt class="py-string"> The keys are the possible left sub-tuples of fully qualified names,</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"><tt class="py-string"> the values are list of strings as provided by the index.</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"><tt class="py-string"> If the list for a given tuple contains a single item, the partial</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"><tt class="py-string"> match is not ambuguous. In this case the string can be looked up in</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"><tt class="py-string"> `_exact_matches`.</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"><tt class="py-string"> If the name fragment is ambiguous, a warning may be issued to the user.</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"><tt class="py-string"> The items can be used to provide an informative message to the user,</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"><tt class="py-string"> to help him qualifying the name in a unambiguous manner.</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prefix</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-string"> Prefix portion for the URL's returned by `get_url()`.</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"><tt class="py-string"> Not very important: only for logging.</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
</div><a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> </tt>
<a name="DocUrlGenerator.get_url"></a><div id="DocUrlGenerator.get_url-def"><a name="L207"></a><tt class="py-lineno">207</tt> <a class="py-toggle" href="#" id="DocUrlGenerator.get_url-toggle" onclick="return toggle('DocUrlGenerator.get_url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.DocUrlGenerator-class.html#get_url">get_url</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-op">:</tt> </tt>
</div><div id="DocUrlGenerator.get_url-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocUrlGenerator.get_url-expanded"><a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-name">cname</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Function epydoc.docintrospecter.get_canonical_name()=epydoc.docintrospecter-module.html#get_canonical_name,Method epydoc.docwriter.xlink.UrlGenerator.get_canonical_name()=epydoc.docwriter.xlink.UrlGenerator-class.html#get_canonical_name"><a title="epydoc.docintrospecter.get_canonical_name
epydoc.docwriter.xlink.UrlGenerator.get_canonical_name" class="py-name" href="#" onclick="return doclink('link-7', 'get_canonical_name', 'link-7');">get_canonical_name</a></tt><tt class="py-op">(</tt><tt id="link-8" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-8', 'name', 'link-5');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> <tt id="link-9" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.url()=epydoc.docwriter.html.HTMLWriter-class.html#url"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-9', 'url', 'link-9');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exact_matches</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">cname</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-10" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-10', 'url', 'link-9');">url</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</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 class="py-comment"># go for a partial match</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">vals</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_partial_names</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">cname</tt><tt class="py-op">)</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">vals</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">IndexError</tt><tt class="py-op">(</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-string">"no object named '%s' found"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-11" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-11', 'name', 'link-5');">name</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>
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">vals</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="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt id="link-12" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-12', 'url', 'link-9');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exact_matches</tt><tt class="py-op">[</tt><tt class="py-name">vals</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="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Class epydoc.docwriter.xlink.UrlGenerator.IndexAmbiguous=epydoc.docwriter.xlink.UrlGenerator.IndexAmbiguous-class.html"><a title="epydoc.docwriter.xlink.UrlGenerator.IndexAmbiguous" class="py-name" href="#" onclick="return doclink('link-13', 'IndexAmbiguous', 'link-13');">IndexAmbiguous</a></tt><tt class="py-op">(</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-string">"found %d objects that '%s' may refer to: %s"</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> <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">vals</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-14" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-14', 'name', 'link-5');">name</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-op">[</tt><tt class="py-string">"'%s'"</tt> <tt class="py-op">%</tt> <tt class="py-name">n</tt> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">vals</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prefix</tt> <tt class="py-op">+</tt> <tt id="link-15" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-15', 'url', 'link-9');">url</a></tt> </tt>
</div><a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> <tt class="py-comment">#{ Content loading</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># ---------------</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="DocUrlGenerator.clear"></a><div id="DocUrlGenerator.clear-def"><a name="L231"></a><tt class="py-lineno">231</tt> <a class="py-toggle" href="#" id="DocUrlGenerator.clear-toggle" onclick="return toggle('DocUrlGenerator.clear');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.DocUrlGenerator-class.html#clear">clear</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="DocUrlGenerator.clear-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocUrlGenerator.clear-expanded"><a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-docstring"> Clear the current class content.</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exact_matches</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method epydoc.docwriter.xlink.DocUrlGenerator.clear()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#clear,Method epydoc.gui.GUILogger.clear()=epydoc.gui.GUILogger-class.html#clear"><a title="epydoc.docwriter.xlink.DocUrlGenerator.clear
epydoc.gui.GUILogger.clear" class="py-name" href="#" onclick="return doclink('link-16', 'clear', 'link-16');">clear</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_partial_names</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="epydoc.docwriter.xlink.DocUrlGenerator.clear
epydoc.gui.GUILogger.clear" class="py-name" href="#" onclick="return doclink('link-17', 'clear', 'link-16');">clear</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> </tt>
<a name="DocUrlGenerator.load_index"></a><div id="DocUrlGenerator.load_index-def"><a name="L238"></a><tt class="py-lineno">238</tt> <a class="py-toggle" href="#" id="DocUrlGenerator.load_index-toggle" onclick="return toggle('DocUrlGenerator.load_index');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.DocUrlGenerator-class.html#load_index">load_index</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">f</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocUrlGenerator.load_index-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocUrlGenerator.load_index-expanded"><a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"><tt class="py-docstring"> Read the content of an index file.</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"><tt class="py-docstring"> Populate the internal maps with the file content using `load_records()`.</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"><tt class="py-docstring"> f : `str` or file</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"><tt class="py-docstring"> a file name or file-like object fron which read the index.</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> </tt>
<a name="L250"></a><tt class="py-lineno">250</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">f</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="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt id="link-18" 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-18', 'open', 'link-18');">open</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Method epydoc.docwriter.xlink.DocUrlGenerator.load_records()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#load_records"><a title="epydoc.docwriter.xlink.DocUrlGenerator.load_records" class="py-name" href="#" onclick="return doclink('link-19', 'load_records', 'link-19');">load_records</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name" targets="Method epydoc.docwriter.xlink.DocUrlGenerator._iter_tuples()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#_iter_tuples"><a title="epydoc.docwriter.xlink.DocUrlGenerator._iter_tuples" class="py-name" href="#" onclick="return doclink('link-20', '_iter_tuples', 'link-20');">_iter_tuples</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> </tt>
<a name="DocUrlGenerator._iter_tuples"></a><div id="DocUrlGenerator._iter_tuples-def"><a name="L255"></a><tt class="py-lineno">255</tt> <a class="py-toggle" href="#" id="DocUrlGenerator._iter_tuples-toggle" onclick="return toggle('DocUrlGenerator._iter_tuples');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.DocUrlGenerator-class.html#_iter_tuples">_iter_tuples</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">f</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocUrlGenerator._iter_tuples-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocUrlGenerator._iter_tuples-expanded"><a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-docstring">"""Iterate on a file returning 2-tuples."""</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">nrow</tt><tt class="py-op">,</tt> <tt class="py-name">row</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"> <tt class="py-comment"># skip blank lines</tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">row</tt> <tt class="py-op">=</tt> <tt class="py-name">row</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">row</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"> <tt class="py-name">rec</tt> <tt class="py-op">=</tt> <tt class="py-name">row</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\t'</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</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">rec</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="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> <tt class="py-keyword">yield</tt> <tt class="py-name">rec</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt id="link-21" 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-21', 'log', 'link-3');">log</a></tt><tt class="py-op">.</tt><tt id="link-22" class="py-name" targets="Method epydoc.checker.DocChecker.warning()=epydoc.checker.DocChecker-class.html#warning,Function epydoc.log.warning()=epydoc.log-module.html#warning"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-22', 'warning', 'link-22');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"invalid row in '%s' row %d: '%s'"</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">nrow</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">row</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> </tt>
<a name="DocUrlGenerator.load_records"></a><div id="DocUrlGenerator.load_records-def"><a name="L269"></a><tt class="py-lineno">269</tt> <a class="py-toggle" href="#" id="DocUrlGenerator.load_records-toggle" onclick="return toggle('DocUrlGenerator.load_records');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.DocUrlGenerator-class.html#load_records">load_records</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">records</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocUrlGenerator.load_records-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocUrlGenerator.load_records-expanded"><a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"><tt class="py-docstring"> Read a sequence of pairs name -> url and populate the internal maps.</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"><tt class="py-docstring"> records : iterable</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"><tt class="py-docstring"> the sequence of pairs (*name*, *url*) to add to the maps.</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-23" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-23', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt id="link-24" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-24', 'url', 'link-9');">url</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">records</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">cname</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="epydoc.docintrospecter.get_canonical_name
epydoc.docwriter.xlink.UrlGenerator.get_canonical_name" class="py-name" href="#" onclick="return doclink('link-25', 'get_canonical_name', 'link-7');">get_canonical_name</a></tt><tt class="py-op">(</tt><tt id="link-26" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-26', 'name', 'link-5');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">cname</tt><tt class="py-op">:</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt id="link-27" 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-27', 'log', 'link-3');">log</a></tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-28', 'warning', 'link-22');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"invalid object name in '%s': '%s'"</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt id="link-29" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-29', 'name', 'link-5');">name</a></tt><tt class="py-op">)</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">continue</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"> <tt class="py-comment"># discard duplicates</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-30" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-30', 'name', 'link-5');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exact_matches</tt><tt class="py-op">:</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exact_matches</tt><tt class="py-op">[</tt><tt id="link-31" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-31', 'name', 'link-5');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-32" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-32', 'url', 'link-9');">url</a></tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_exact_matches</tt><tt class="py-op">[</tt><tt class="py-name">cname</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-33" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-33', 'url', 'link-9');">url</a></tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-comment"># Link the different ambiguous fragments to the url</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"><tt class="py-comment"></tt> <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-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">cname</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_partial_names</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">cname</tt><tt class="py-op">[</tt><tt class="py-name">i</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-name">append</tt><tt class="py-op">(</tt><tt id="link-34" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-34', 'name', 'link-5');">name</a></tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"><tt class="py-comment">#{ API register</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># ------------</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"><tt id="link-35" class="py-name" targets="Variable epydoc.docwriter.xlink.api_register=epydoc.docwriter.xlink-module.html#api_register"><a title="epydoc.docwriter.xlink.api_register" class="py-name" href="#" onclick="return doclink('link-35', 'api_register', 'link-35');">api_register</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"><tt class="py-string">Mapping from the API name to the `UrlGenerator` to be used.</tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"><tt class="py-string">Use `register_api()` to add new generators to the register.</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> </tt>
<a name="register_api"></a><div id="register_api-def"><a name="L305"></a><tt class="py-lineno">305</tt> <a class="py-toggle" href="#" id="register_api-toggle" onclick="return toggle('register_api');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink-module.html#register_api">register_api</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">generator</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="register_api-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="register_api-expanded"><a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> <tt class="py-docstring">"""Register the API `name` into the `api_register`.</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"><tt class="py-docstring"> A registered API will be available to the markup as the interpreted text</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"><tt class="py-docstring"> role ``name``.</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"><tt class="py-docstring"> If a `generator` is not provided, register a `VoidUrlGenerator` instance:</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"><tt class="py-docstring"> in this case no warning will be issued for missing names, but no URL will</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"><tt class="py-docstring"> be generated and all the dotted names will simply be rendered as literals.</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"><tt class="py-docstring"> `name` : `str`</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"><tt class="py-docstring"> the name of the generator to be registered</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"><tt class="py-docstring"> `generator` : `UrlGenerator`</tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"><tt class="py-docstring"> the object to register to translate names into URLs.</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">generator</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</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">generator</tt> <tt class="py-op">=</tt> <tt id="link-36" class="py-name" targets="Class epydoc.docwriter.xlink.VoidUrlGenerator=epydoc.docwriter.xlink.VoidUrlGenerator-class.html"><a title="epydoc.docwriter.xlink.VoidUrlGenerator" class="py-name" href="#" onclick="return doclink('link-36', 'VoidUrlGenerator', 'link-36');">VoidUrlGenerator</a></tt><tt class="py-op">(</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 id="link-37" class="py-name"><a title="epydoc.docwriter.xlink.api_register" class="py-name" href="#" onclick="return doclink('link-37', 'api_register', 'link-35');">api_register</a></tt><tt class="py-op">[</tt><tt id="link-38" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-38', 'name', 'link-5');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">generator</tt> </tt>
</div><a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"> </tt>
<a name="set_api_file"></a><div id="set_api_file-def"><a name="L326"></a><tt class="py-lineno">326</tt> <a class="py-toggle" href="#" id="set_api_file-toggle" onclick="return toggle('set_api_file');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink-module.html#set_api_file">set_api_file</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">file</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_api_file-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="set_api_file-expanded"><a name="L327"></a><tt class="py-lineno">327</tt> <tt class="py-line"> <tt class="py-docstring">"""Set an URL generator populated with data from `file`.</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"><tt class="py-docstring"> Use `file` to populate a new `DocUrlGenerator` instance and register it</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"><tt class="py-docstring"> as `name`.</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"><tt class="py-docstring"> `name` : `str`</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"><tt class="py-docstring"> the name of the generator to be registered</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"><tt class="py-docstring"> `file` : `str` or file</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"><tt class="py-docstring"> the file to parse populate the URL generator</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"> <tt class="py-name">generator</tt> <tt class="py-op">=</tt> <tt id="link-39" class="py-name" targets="Class epydoc.docwriter.xlink.DocUrlGenerator=epydoc.docwriter.xlink.DocUrlGenerator-class.html"><a title="epydoc.docwriter.xlink.DocUrlGenerator" class="py-name" href="#" onclick="return doclink('link-39', 'DocUrlGenerator', 'link-39');">DocUrlGenerator</a></tt><tt class="py-op">(</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">generator</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Method epydoc.docwriter.xlink.DocUrlGenerator.load_index()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#load_index"><a title="epydoc.docwriter.xlink.DocUrlGenerator.load_index" class="py-name" href="#" onclick="return doclink('link-40', 'load_index', 'link-40');">load_index</a></tt><tt class="py-op">(</tt><tt class="py-name">file</tt><tt class="py-op">)</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"> <tt id="link-41" class="py-name" targets="Function epydoc.docwriter.xlink.register_api()=epydoc.docwriter.xlink-module.html#register_api"><a title="epydoc.docwriter.xlink.register_api" class="py-name" href="#" onclick="return doclink('link-41', 'register_api', 'link-41');">register_api</a></tt><tt class="py-op">(</tt><tt id="link-42" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-42', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">generator</tt><tt class="py-op">)</tt> </tt>
</div><a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"> </tt>
<a name="set_api_root"></a><div id="set_api_root-def"><a name="L342"></a><tt class="py-lineno">342</tt> <a class="py-toggle" href="#" id="set_api_root-toggle" onclick="return toggle('set_api_root');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink-module.html#set_api_root">set_api_root</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">prefix</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_api_root-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="set_api_root-expanded"><a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"> <tt class="py-docstring">"""Set the root for the URLs returned by a registered URL generator.</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"><tt class="py-docstring"> `name` : `str`</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"><tt class="py-docstring"> the name of the generator to be updated</tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"><tt class="py-docstring"> `prefix` : `str`</tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"><tt class="py-docstring"> the prefix for the generated URL's</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"><tt class="py-docstring"> :Exceptions:</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"><tt class="py-docstring"> - `IndexError`: `name` is not a registered generator</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"> <tt id="link-43" class="py-name"><a title="epydoc.docwriter.xlink.api_register" class="py-name" href="#" onclick="return doclink('link-43', 'api_register', 'link-35');">api_register</a></tt><tt class="py-op">[</tt><tt id="link-44" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-44', 'name', 'link-5');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">prefix</tt> <tt class="py-op">=</tt> <tt class="py-name">prefix</tt> </tt>
</div><a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Below this point requires docutils.</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">docutils</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">parsers</tt><tt class="py-op">.</tt><tt class="py-name">rst</tt> <tt class="py-keyword">import</tt> <tt class="py-name">roles</tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt> <tt class="py-keyword">import</tt> <tt class="py-name">nodes</tt><tt class="py-op">,</tt> <tt class="py-name">utils</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">docutils</tt><tt class="py-op">.</tt><tt class="py-name">readers</tt><tt class="py-op">.</tt><tt class="py-name">standalone</tt> <tt class="py-keyword">import</tt> <tt class="py-name">Reader</tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"> <tt class="py-name">docutils</tt> <tt class="py-op">=</tt> <tt class="py-name">roles</tt> <tt class="py-op">=</tt> <tt class="py-name">nodes</tt> <tt class="py-op">=</tt> <tt class="py-name">utils</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="Reader"></a><div id="Reader-def"><a name="L365"></a><tt class="py-lineno">365</tt> <a class="py-toggle" href="#" id="Reader-toggle" onclick="return toggle('Reader');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.Reader-class.html">Reader</a><tt class="py-op">:</tt> <tt id="link-45" class="py-name" targets="Variable epydoc.docwriter.xlink.ApiLinkReader.settings_spec=epydoc.docwriter.xlink.ApiLinkReader-class.html#settings_spec"><a title="epydoc.docwriter.xlink.ApiLinkReader.settings_spec" class="py-name" href="#" onclick="return doclink('link-45', 'settings_spec', 'link-45');">settings_spec</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"> </tt>
<a name="create_api_role"></a><div id="create_api_role-def"><a name="L367"></a><tt class="py-lineno">367</tt> <a class="py-toggle" href="#" id="create_api_role-toggle" onclick="return toggle('create_api_role');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink-module.html#create_api_role">create_api_role</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">problematic</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="create_api_role-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="create_api_role-expanded"><a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L369"></a><tt class="py-lineno">369</tt> <tt class="py-line"><tt class="py-docstring"> Create and register a new role to create links for an API documentation.</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"><tt class="py-docstring"> Create a role called `name`, which will use the URL resolver registered as</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"><tt class="py-docstring"> ``name`` in `api_register` to create a link for an object.</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"><tt class="py-docstring"> `name` : `str`</tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"><tt class="py-docstring"> name of the role to create.</tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt> <tt class="py-line"><tt class="py-docstring"> `problematic` : `bool`</tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"><tt class="py-docstring"> if True, the registered role will create problematic nodes in</tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"><tt class="py-docstring"> case of failed references. If False, a warning will be raised</tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"><tt class="py-docstring"> anyway, but the output will appear as an ordinary literal.</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">resolve_api_name</tt><tt class="py-op">(</tt><tt class="py-param">n</tt><tt class="py-op">,</tt> <tt class="py-param">rawtext</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> <tt class="py-param">inliner</tt><tt class="py-op">,</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"> <tt class="py-param">options</tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">docutils</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</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">'requires docutils'</tt><tt class="py-op">)</tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt> <tt class="py-line"> <tt class="py-comment"># node in monotype font</tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">text</tt> <tt class="py-op">=</tt> <tt class="py-name">utils</tt><tt class="py-op">.</tt><tt class="py-name">unescape</tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">)</tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt> <tt class="py-line"> <tt class="py-name">node</tt> <tt class="py-op">=</tt> <tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">literal</tt><tt class="py-op">(</tt><tt class="py-name">rawtext</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"> <tt class="py-comment"># Get the resolver from the register and create an url from it.</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"> <tt id="link-46" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-46', 'url', 'link-9');">url</a></tt> <tt class="py-op">=</tt> <tt id="link-47" class="py-name"><a title="epydoc.docwriter.xlink.api_register" class="py-name" href="#" onclick="return doclink('link-47', 'api_register', 'link-35');">api_register</a></tt><tt class="py-op">[</tt><tt id="link-48" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-48', 'name', 'link-5');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name" targets="Method epydoc.docwriter.xlink.DocUrlGenerator.get_url()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#get_url,Method epydoc.docwriter.xlink.UrlGenerator.get_url()=epydoc.docwriter.xlink.UrlGenerator-class.html#get_url,Method epydoc.docwriter.xlink.VoidUrlGenerator.get_url()=epydoc.docwriter.xlink.VoidUrlGenerator-class.html#get_url"><a title="epydoc.docwriter.xlink.DocUrlGenerator.get_url
epydoc.docwriter.xlink.UrlGenerator.get_url
epydoc.docwriter.xlink.VoidUrlGenerator.get_url" class="py-name" href="#" onclick="return doclink('link-49', 'get_url', 'link-49');">get_url</a></tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">)</tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IndexError</tt><tt class="py-op">,</tt> <tt class="py-name">exc</tt><tt class="py-op">:</tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">inliner</tt><tt class="py-op">.</tt><tt class="py-name">reporter</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-50', 'warning', 'link-22');">warning</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">exc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">line</tt><tt class="py-op">=</tt><tt id="link-51" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.lineno=epydoc.apidoc.RoutineDoc-class.html#lineno"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-51', 'lineno', 'link-51');">lineno</a></tt><tt class="py-op">)</tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">problematic</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">prb</tt> <tt class="py-op">=</tt> <tt class="py-name">inliner</tt><tt class="py-op">.</tt><tt class="py-name">problematic</tt><tt class="py-op">(</tt><tt class="py-name">rawtext</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">prb</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-name">msg</tt><tt class="py-op">]</tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"> <tt class="py-keyword">else</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">return</tt> <tt class="py-op">[</tt><tt class="py-name">node</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt> <tt class="py-line"> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-52" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-52', 'url', 'link-9');">url</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="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"> <tt class="py-name">node</tt> <tt class="py-op">=</tt> <tt class="py-name">nodes</tt><tt class="py-op">.</tt><tt class="py-name">reference</tt><tt class="py-op">(</tt><tt class="py-name">rawtext</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">node</tt><tt class="py-op">,</tt> <tt class="py-name">refuri</tt><tt class="py-op">=</tt><tt id="link-53" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-53', 'url', 'link-9');">url</a></tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">node</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L405"></a><tt class="py-lineno">405</tt> <tt class="py-line"> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"> <tt class="py-name">roles</tt><tt class="py-op">.</tt><tt class="py-name">register_local_role</tt><tt class="py-op">(</tt><tt id="link-54" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-54', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">resolve_api_name</tt><tt class="py-op">)</tt> </tt>
</div><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>
<a name="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"><tt class="py-comment">#{ Command line parsing</tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># --------------------</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"> </tt>
<a name="split_name"></a><div id="split_name-def"><a name="L413"></a><tt class="py-lineno">413</tt> <a class="py-toggle" href="#" id="split_name-toggle" onclick="return toggle('split_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink-module.html#split_name">split_name</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="split_name-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="split_name-expanded"><a name="L414"></a><tt class="py-lineno">414</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt> <tt class="py-line"><tt class="py-docstring"> Split an option in form ``NAME:VALUE`` and check if ``NAME`` exists.</tt> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L417"></a><tt class="py-lineno">417</tt> <tt class="py-line"> <tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt id="link-55" 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-55', 'value', 'link-55');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">':'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L418"></a><tt class="py-lineno">418</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">parts</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="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">OptionValueError</tt><tt class="py-op">(</tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"> <tt class="py-string">"option value must be specified as NAME:VALUE; got '%s' instead"</tt> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt id="link-56" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-56', 'value', 'link-55');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt> <tt class="py-line"> <tt id="link-57" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-57', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">parts</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-keyword">if</tt> <tt id="link-58" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-58', 'name', 'link-5');">name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-59" class="py-name"><a title="epydoc.docwriter.xlink.api_register" class="py-name" href="#" onclick="return doclink('link-59', 'api_register', 'link-35');">api_register</a></tt><tt class="py-op">:</tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">OptionValueError</tt><tt class="py-op">(</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"> <tt class="py-string">"the name '%s' has not been registered; use --external-api"</tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt id="link-60" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-60', 'name', 'link-5');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt> <tt class="py-line"> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt id="link-61" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-61', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">val</tt><tt class="py-op">)</tt> </tt>
</div><a name="L431"></a><tt class="py-lineno">431</tt> <tt class="py-line"> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"> </tt>
<a name="ApiLinkReader"></a><div id="ApiLinkReader-def"><a name="L433"></a><tt class="py-lineno">433</tt> <a class="py-toggle" href="#" id="ApiLinkReader-toggle" onclick="return toggle('ApiLinkReader');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.ApiLinkReader-class.html">ApiLinkReader</a><tt class="py-op">(</tt><tt class="py-base-class">Reader</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiLinkReader-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ApiLinkReader-expanded"><a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt> <tt class="py-line"><tt class="py-docstring"> A Docutils standalone reader allowing external documentation links.</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"><tt class="py-docstring"> The reader configure the url resolvers at the time `read()` is invoked the</tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt> <tt class="py-line"><tt class="py-docstring"> first time.</tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L440"></a><tt class="py-lineno">440</tt> <tt class="py-line"> <tt class="py-comment">#: The option parser configuration.</tt> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-62" class="py-name"><a title="epydoc.docwriter.xlink.ApiLinkReader.settings_spec" class="py-name" href="#" onclick="return doclink('link-62', 'settings_spec', 'link-45');">settings_spec</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt> </tt>
<a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"> <tt class="py-string">'API Linking Options'</tt><tt class="py-op">,</tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"> <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-string">'Define a new API document. A new interpreted text role NAME will be '</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt> <tt class="py-line"> <tt class="py-string">'added.'</tt><tt class="py-op">,</tt> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-string">'--external-api'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt> <tt class="py-line"> <tt class="py-op">{</tt><tt class="py-string">'metavar'</tt><tt class="py-op">:</tt> <tt class="py-string">'NAME'</tt><tt class="py-op">,</tt> <tt class="py-string">'action'</tt><tt class="py-op">:</tt> <tt class="py-string">'append'</tt><tt class="py-op">}</tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"> <tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"> <tt class="py-string">'Use records in FILENAME to resolve objects in the API named NAME.'</tt><tt class="py-op">,</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-string">'--external-api-file'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt> <tt class="py-line"> <tt class="py-op">{</tt><tt class="py-string">'metavar'</tt><tt class="py-op">:</tt> <tt class="py-string">'NAME:FILENAME'</tt><tt class="py-op">,</tt> <tt class="py-string">'action'</tt><tt class="py-op">:</tt> <tt class="py-string">'append'</tt><tt class="py-op">}</tt> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt> <tt class="py-line"> <tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"> <tt class="py-string">'Use STRING as prefix for the URL generated from the API NAME.'</tt><tt class="py-op">,</tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-string">'--external-api-root'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt> <tt class="py-line"> <tt class="py-op">{</tt><tt class="py-string">'metavar'</tt><tt class="py-op">:</tt> <tt class="py-string">'NAME:STRING'</tt><tt class="py-op">,</tt> <tt class="py-string">'action'</tt><tt class="py-op">:</tt> <tt class="py-string">'append'</tt><tt class="py-op">}</tt> </tt>
<a name="L457"></a><tt class="py-lineno">457</tt> <tt class="py-line"> <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">Reader</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="epydoc.docwriter.xlink.ApiLinkReader.settings_spec" class="py-name" href="#" onclick="return doclink('link-63', 'settings_spec', 'link-45');">settings_spec</a></tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"> </tt>
<a name="ApiLinkReader.__init__"></a><div id="ApiLinkReader.__init__-def"><a name="L459"></a><tt class="py-lineno">459</tt> <a class="py-toggle" href="#" id="ApiLinkReader.__init__-toggle" onclick="return toggle('ApiLinkReader.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.ApiLinkReader-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiLinkReader.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ApiLinkReader.__init__-expanded"><a name="L460"></a><tt class="py-lineno">460</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">docutils</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</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">'requires docutils'</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">Reader</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name" targets="Method epydoc.apidoc.APIDoc.__init__()=epydoc.apidoc.APIDoc-class.html#__init__,Method epydoc.apidoc.DocIndex.__init__()=epydoc.apidoc.DocIndex-class.html#__init__,Method epydoc.apidoc.DottedName.__init__()=epydoc.apidoc.DottedName-class.html#__init__,Method epydoc.apidoc.NamespaceDoc.__init__()=epydoc.apidoc.NamespaceDoc-class.html#__init__,Method epydoc.apidoc.VariableDoc.__init__()=epydoc.apidoc.VariableDoc-class.html#__init__,Method epydoc.apidoc._Sentinel.__init__()=epydoc.apidoc._Sentinel-class.html#__init__,Method epydoc.checker.DocChecker.__init__()=epydoc.checker.DocChecker-class.html#__init__,Method epydoc.cli.ConsoleLogger.__init__()=epydoc.cli.ConsoleLogger-class.html#__init__,Method epydoc.cli.HTMLLogger.__init__()=epydoc.cli.HTMLLogger-class.html#__init__,Method epydoc.cli.TerminalController.__init__()=epydoc.cli.TerminalController-class.html#__init__,Method epydoc.cli.UnifiedProgressConsoleLogger.__init__()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#__init__,Method epydoc.docbuilder.BuildOptions.__init__()=epydoc.docbuilder.BuildOptions-class.html#__init__,Method epydoc.docbuilder._ProgressEstimator.__init__()=epydoc.docbuilder._ProgressEstimator-class.html#__init__,Method epydoc.docintrospecter._DevNull.__init__()=epydoc.docintrospecter._DevNull-class.html#__init__,Method epydoc.docstringparser.DocstringField.__init__()=epydoc.docstringparser.DocstringField-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraph.__init__()=epydoc.docwriter.dotgraph.DotGraph-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphEdge.__init__()=epydoc.docwriter.dotgraph.DotGraphEdge-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphNode.__init__()=epydoc.docwriter.dotgraph.DotGraphNode-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__()=epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__()=epydoc.docwriter.dotgraph.DotGraphUmlModuleNode-class.html#__init__,Method epydoc.docwriter.html.HTMLWriter.__init__()=epydoc.docwriter.html.HTMLWriter-class.html#__init__,Method epydoc.docwriter.html._HTMLDocstringLinker.__init__()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__,Method epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__()=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#__init__,Method epydoc.docwriter.latex.LatexWriter.__init__()=epydoc.docwriter.latex.LatexWriter-class.html#__init__,Method epydoc.docwriter.xlink.ApiLinkReader.__init__()=epydoc.docwriter.xlink.ApiLinkReader-class.html#__init__,Method epydoc.docwriter.xlink.DocUrlGenerator.__init__()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#__init__,Method epydoc.gui.EpydocGUI.__init__()=epydoc.gui.EpydocGUI-class.html#__init__,Method epydoc.gui.GUILogger.__init__()=epydoc.gui.GUILogger-class.html#__init__,Method epydoc.log.SimpleLogger.__init__()=epydoc.log.SimpleLogger-class.html#__init__,Method epydoc.markup.ConcatenatedDocstring.__init__()=epydoc.markup.ConcatenatedDocstring-class.html#__init__,Method epydoc.markup.Field.__init__()=epydoc.markup.Field-class.html#__init__,Method epydoc.markup.ParseError.__init__()=epydoc.markup.ParseError-class.html#__init__,Method epydoc.markup.epytext.ColorizingError.__init__()=epydoc.markup.epytext.ColorizingError-class.html#__init__,Method epydoc.markup.epytext.Element.__init__()=epydoc.markup.epytext.Element-class.html#__init__,Method epydoc.markup.epytext.ParsedEpytextDocstring.__init__()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__init__,Method epydoc.markup.epytext.Token.__init__()=epydoc.markup.epytext.Token-class.html#__init__,Method epydoc.markup.javadoc.ParsedJavadocDocstring.__init__()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#__init__,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__,Method epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__()=epydoc.markup.pyval_repr.ColorizedPyvalRepr-class.html#__init__,Method epydoc.markup.pyval_repr.PyvalColorizer.__init__()=epydoc.markup.pyval_repr.PyvalColorizer-class.html#__init__,Method epydoc.markup.pyval_repr._ColorizerState.__init__()=epydoc.markup.pyval_repr._ColorizerState-class.html#__init__,Method epydoc.markup.restructuredtext.ParsedRstDocstring.__init__()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#__init__,Method epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__()=epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__()=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__()=epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocReader.__init__()=epydoc.markup.restructuredtext._EpydocReader-class.html#__init__,Method epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__()=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._SummaryExtractor.__init__()=epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__,Method epydoc.markup.restructuredtext._TermsExtractor.__init__()=epydoc.markup.restructuredtext._TermsExtractor-class.html#__init__,Method epydoc.markup.restructuredtext.dotgraph.__init__()=epydoc.markup.restructuredtext.dotgraph-class.html#__init__,Method epydoc.util.RunSubprocessError.__init__()=epydoc.util.RunSubprocessError-class.html#__init__"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-64', '__init__', 'link-64');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</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-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L463"></a><tt class="py-lineno">463</tt> <tt class="py-line"> </tt>
<a name="ApiLinkReader.read"></a><div id="ApiLinkReader.read-def"><a name="L464"></a><tt class="py-lineno">464</tt> <a class="py-toggle" href="#" id="ApiLinkReader.read-toggle" onclick="return toggle('ApiLinkReader.read');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.ApiLinkReader-class.html#read">read</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">source</tt><tt class="py-op">,</tt> <tt class="py-param">parser</tt><tt class="py-op">,</tt> <tt class="py-param">settings</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiLinkReader.read-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ApiLinkReader.read-expanded"><a name="L465"></a><tt class="py-lineno">465</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name" targets="Class Method epydoc.docwriter.xlink.ApiLinkReader.read_configuration()=epydoc.docwriter.xlink.ApiLinkReader-class.html#read_configuration"><a title="epydoc.docwriter.xlink.ApiLinkReader.read_configuration" class="py-name" href="#" onclick="return doclink('link-65', 'read_configuration', 'link-65');">read_configuration</a></tt><tt class="py-op">(</tt><tt id="link-66" class="py-name" targets="Variable epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#settings,Variable epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings=epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#settings"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-66', 'settings', 'link-66');">settings</a></tt><tt class="py-op">,</tt> <tt class="py-name">problematic</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">Reader</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name" targets="Method epydoc.docintrospecter._DevNull.read()=epydoc.docintrospecter._DevNull-class.html#read,Method epydoc.docwriter.xlink.ApiLinkReader.read()=epydoc.docwriter.xlink.ApiLinkReader-class.html#read,Method epydoc.gui.GUILogger.read()=epydoc.gui.GUILogger-class.html#read"><a title="epydoc.docintrospecter._DevNull.read
epydoc.docwriter.xlink.ApiLinkReader.read
epydoc.gui.GUILogger.read" class="py-name" href="#" onclick="return doclink('link-67', 'read', 'link-67');">read</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">source</tt><tt class="py-op">,</tt> <tt class="py-name">parser</tt><tt class="py-op">,</tt> <tt id="link-68" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-68', 'settings', 'link-66');">settings</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L467"></a><tt class="py-lineno">467</tt> <tt class="py-line"> </tt>
<a name="ApiLinkReader.read_configuration"></a><div id="ApiLinkReader.read_configuration-def"><a name="L468"></a><tt class="py-lineno">468</tt> <a class="py-toggle" href="#" id="ApiLinkReader.read_configuration-toggle" onclick="return toggle('ApiLinkReader.read_configuration');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.xlink.ApiLinkReader-class.html#read_configuration">read_configuration</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">settings</tt><tt class="py-op">,</tt> <tt class="py-param">problematic</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiLinkReader.read_configuration-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ApiLinkReader.read_configuration-expanded"><a name="L469"></a><tt class="py-lineno">469</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt> <tt class="py-line"><tt class="py-docstring"> Read the configuration for the configured URL resolver.</tt> </tt>
<a name="L471"></a><tt class="py-lineno">471</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L472"></a><tt class="py-lineno">472</tt> <tt class="py-line"><tt class="py-docstring"> Register a new role for each configured API.</tt> </tt>
<a name="L473"></a><tt class="py-lineno">473</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt> <tt class="py-line"><tt class="py-docstring"> :Parameters:</tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt> <tt class="py-line"><tt class="py-docstring"> `settings`</tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt> <tt class="py-line"><tt class="py-docstring"> the settings structure containing the options to read.</tt> </tt>
<a name="L477"></a><tt class="py-lineno">477</tt> <tt class="py-line"><tt class="py-docstring"> `problematic` : `bool`</tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt> <tt class="py-line"><tt class="py-docstring"> if True, the registered role will create problematic nodes in</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt> <tt class="py-line"><tt class="py-docstring"> case of failed references. If False, a warning will be raised</tt> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt> <tt class="py-line"><tt class="py-docstring"> anyway, but the output will appear as an ordinary literal.</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-comment"># Read config only once</tt> </tt>
<a name="L483"></a><tt class="py-lineno">483</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-string">'_conf'</tt><tt class="py-op">)</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">return</tt> </tt>
<a name="L485"></a><tt class="py-lineno">485</tt> <tt class="py-line"> <tt id="link-69" class="py-name" targets="Class epydoc.docwriter.xlink.ApiLinkReader=epydoc.docwriter.xlink.ApiLinkReader-class.html"><a title="epydoc.docwriter.xlink.ApiLinkReader" class="py-name" href="#" onclick="return doclink('link-69', 'ApiLinkReader', 'link-69');">ApiLinkReader</a></tt><tt class="py-op">.</tt><tt id="link-70" class="py-name" targets="Variable epydoc.docwriter.xlink.ApiLinkReader._conf=epydoc.docwriter.xlink.ApiLinkReader-class.html#_conf"><a title="epydoc.docwriter.xlink.ApiLinkReader._conf" class="py-name" href="#" onclick="return doclink('link-70', '_conf', 'link-70');">_conf</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt> <tt class="py-line"> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L488"></a><tt class="py-lineno">488</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-71" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-71', 'settings', 'link-66');">settings</a></tt><tt class="py-op">.</tt><tt class="py-name">external_api</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="L489"></a><tt class="py-lineno">489</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-72" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-72', 'name', 'link-5');">name</a></tt> <tt class="py-keyword">in</tt> <tt id="link-73" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-73', 'settings', 'link-66');">settings</a></tt><tt class="py-op">.</tt><tt class="py-name">external_api</tt><tt class="py-op">:</tt> </tt>
<a name="L490"></a><tt class="py-lineno">490</tt> <tt class="py-line"> <tt id="link-74" class="py-name"><a title="epydoc.docwriter.xlink.register_api" class="py-name" href="#" onclick="return doclink('link-74', 'register_api', 'link-41');">register_api</a></tt><tt class="py-op">(</tt><tt id="link-75" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-75', 'name', 'link-5');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt> <tt class="py-line"> <tt id="link-76" class="py-name" targets="Function epydoc.docwriter.xlink.create_api_role()=epydoc.docwriter.xlink-module.html#create_api_role"><a title="epydoc.docwriter.xlink.create_api_role" class="py-name" href="#" onclick="return doclink('link-76', 'create_api_role', 'link-76');">create_api_role</a></tt><tt class="py-op">(</tt><tt id="link-77" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-77', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">problematic</tt><tt class="py-op">=</tt><tt class="py-name">problematic</tt><tt class="py-op">)</tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt> <tt class="py-line"> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-78" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-78', 'settings', 'link-66');">settings</a></tt><tt class="py-op">.</tt><tt class="py-name">external_api_file</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="L494"></a><tt class="py-lineno">494</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-79" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-79', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">file</tt> <tt class="py-keyword">in</tt> <tt class="py-name">map</tt><tt class="py-op">(</tt><tt id="link-80" class="py-name" targets="Function epydoc.docwriter.xlink.split_name()=epydoc.docwriter.xlink-module.html#split_name"><a title="epydoc.docwriter.xlink.split_name" class="py-name" href="#" onclick="return doclink('link-80', 'split_name', 'link-80');">split_name</a></tt><tt class="py-op">,</tt> <tt id="link-81" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-81', 'settings', 'link-66');">settings</a></tt><tt class="py-op">.</tt><tt class="py-name">external_api_file</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L495"></a><tt class="py-lineno">495</tt> <tt class="py-line"> <tt id="link-82" class="py-name" targets="Function epydoc.docwriter.xlink.set_api_file()=epydoc.docwriter.xlink-module.html#set_api_file"><a title="epydoc.docwriter.xlink.set_api_file" class="py-name" href="#" onclick="return doclink('link-82', 'set_api_file', 'link-82');">set_api_file</a></tt><tt class="py-op">(</tt><tt id="link-83" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-83', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">file</tt><tt class="py-op">)</tt> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt> <tt class="py-line"> </tt>
<a name="L497"></a><tt class="py-lineno">497</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-84" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-84', 'settings', 'link-66');">settings</a></tt><tt class="py-op">.</tt><tt class="py-name">external_api_root</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="L498"></a><tt class="py-lineno">498</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-85" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-85', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">root</tt> <tt class="py-keyword">in</tt> <tt class="py-name">map</tt><tt class="py-op">(</tt><tt id="link-86" class="py-name"><a title="epydoc.docwriter.xlink.split_name" class="py-name" href="#" onclick="return doclink('link-86', 'split_name', 'link-80');">split_name</a></tt><tt class="py-op">,</tt> <tt id="link-87" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocHTMLTranslator.settings
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.settings" class="py-name" href="#" onclick="return doclink('link-87', 'settings', 'link-66');">settings</a></tt><tt class="py-op">.</tt><tt class="py-name">external_api_root</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L499"></a><tt class="py-lineno">499</tt> <tt class="py-line"> <tt id="link-88" class="py-name" targets="Function epydoc.docwriter.xlink.set_api_root()=epydoc.docwriter.xlink-module.html#set_api_root"><a title="epydoc.docwriter.xlink.set_api_root" class="py-name" href="#" onclick="return doclink('link-88', 'set_api_root', 'link-88');">set_api_root</a></tt><tt class="py-op">(</tt><tt id="link-89" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-89', 'name', 'link-5');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">root</tt><tt class="py-op">)</tt> </tt>
<a name="L500"></a><tt class="py-lineno">500</tt> <tt class="py-line"> </tt>
<a name="L501"></a><tt class="py-lineno">501</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">OptionValueError</tt><tt class="py-op">,</tt> <tt class="py-name">exc</tt><tt class="py-op">:</tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</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">exc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt class="py-name">exc</tt><tt class="py-op">)</tt> </tt>
<a name="L503"></a><tt class="py-lineno">503</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">exit</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
</div><a name="L504"></a><tt class="py-lineno">504</tt> <tt class="py-line"> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt> <tt class="py-line"> <tt id="link-90" class="py-name"><a title="epydoc.docwriter.xlink.ApiLinkReader.read_configuration" class="py-name" href="#" onclick="return doclink('link-90', 'read_configuration', 'link-65');">read_configuration</a></tt> <tt class="py-op">=</tt> <tt class="py-name">classmethod</tt><tt class="py-op">(</tt><tt id="link-91" class="py-name"><a title="epydoc.docwriter.xlink.ApiLinkReader.read_configuration" class="py-name" href="#" onclick="return doclink('link-91', 'read_configuration', 'link-65');">read_configuration</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L506"></a><tt class="py-lineno">506</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:34 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>
