<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.markup.restructuredtext.dotgraph</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
<a href="epydoc.markup.restructuredtext-module.html">Module restructuredtext</a> ::
Class dotgraph
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.markup.restructuredtext.dotgraph-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class dotgraph</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#dotgraph">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_epydoc_m_27" name="uml_class_diagram_for_epydoc_m_27">
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.image.astext" alt="" coords="208,753,333,772" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.image" alt="" coords="196,723,345,779" />
<area shape="rect" href="epydoc.markup.restructuredtext.dotgraph-class.html#__init__" title="epydoc.markup.restructuredtext.dotgraph.__init__" alt="" coords="92,828,449,847" />
<area shape="rect" href="epydoc.markup.restructuredtext.dotgraph-class.html#graph" title="epydoc.markup.restructuredtext.dotgraph.graph" alt="" coords="92,847,449,865" />
<area shape="rect" href="epydoc.markup.restructuredtext.dotgraph-class.html" title="A custom docutils node that should be rendered using Graphviz dot." alt="" coords="80,797,461,872" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.General" alt="" coords="5,471,168,513" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Inline" alt="" coords="197,471,344,513" />
<area shape="rect" href="javascript:void(0);" title="List attributes, automatically initialized to empty lists for all nodes." alt="" coords="385,303,679,321" />
<area shape="rect" href="javascript:void(0);" title="The element generic identifier." alt="" coords="385,321,679,340" />
<area shape="rect" href="javascript:void(0);" title="Separator for child nodes, used by astext() method." alt="" coords="385,340,679,359" />
<area shape="rect" href="javascript:void(0);" title="The raw text from which this element was constructed." alt="" coords="385,359,679,377" />
<area shape="rect" href="javascript:void(0);" title="List of child nodes (elements and/or Text)." alt="" coords="385,377,679,396" />
<area shape="rect" href="javascript:void(0);" title="Dictionary of attribute {name: value}." alt="" coords="385,396,679,415" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__repr__" alt="" coords="385,417,679,436" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.shortrepr" alt="" coords="385,436,679,455" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__unicode__" alt="" coords="385,455,679,473" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.starttag" alt="" coords="385,473,679,492" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.endtag" alt="" coords="385,492,679,511" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.emptytag" alt="" coords="385,511,679,529" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__len__" alt="" coords="385,529,679,548" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__getitem__" alt="" coords="385,548,679,567" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__setitem__" alt="" coords="385,567,679,585" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__delitem__" alt="" coords="385,585,679,604" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__add__" alt="" coords="385,604,679,623" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__radd__" alt="" coords="385,623,679,641" />
<area shape="rect" href="javascript:void(0);" title="Append a node or a list of nodes to self.children." alt="" coords="385,641,679,660" />
<area shape="rect" href="javascript:void(0);" title="Note that this Element has been referenced by its name name or id id." alt="" coords="385,679,679,697" />
<area shape="rect" href="javascript:void(0);" title="Element is the superclass to all specific elements." alt="" coords="373,280,691,704" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Body" alt="" coords="15,112,159,155" />
<area shape="rect" href="javascript:void(0);" title="Back-reference to the Node immediately containing this Node." alt="" coords="284,28,780,47" />
<area shape="rect" href="javascript:void(0);" title="The document node at the root of the tree containing this Node." alt="" coords="284,47,780,65" />
<area shape="rect" href="javascript:void(0);" title="Path or description of the input source which generated this Node." alt="" coords="284,65,780,84" />
<area shape="rect" href="javascript:void(0);" title="The line number (1-based) of the beginning of this Node in source." alt="" coords="284,84,780,103" />
<area shape="rect" href="javascript:void(0);" title="Node instances are always true, even if they're empty." alt="" coords="284,105,780,124" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Node.__str__" alt="" coords="284,124,780,143" />
<area shape="rect" href="javascript:void(0);" title="Return a DOM fragment representation of this Node." alt="" coords="284,143,780,161" />
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Node.setup_child" alt="" coords="284,161,780,180" />
<area shape="rect" href="javascript:void(0);" title="Traverse a tree of Node objects, calling the dispatch_visit() method of visitor when entering each node." alt="" coords="284,180,780,199" />
<area shape="rect" href="javascript:void(0);" title="Perform a tree traversal similarly to Node.walk() (which see), except also call the dispatch_departure() method before exiting each node." alt="" coords="284,199,780,217" />
<area shape="rect" href="javascript:void(0);" title="Return an iterable containing" alt="" coords="284,217,780,236" />
<area shape="rect" href="javascript:void(0);" title="Return the first node in the iterable returned by traverse(), or None if the iterable is empty." alt="" coords="284,236,780,255" />
<area shape="rect" href="javascript:void(0);" title="Abstract base class of nodes in a document tree." alt="" coords="272,5,792,261" />
</map>
<img src="uml_class_diagram_for_epydoc_m_27.gif" alt='' usemap="#uml_class_diagram_for_epydoc_m_27" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>A custom docutils node that should be rendered using Graphviz dot.
This node does not directly store the graph; instead, it stores a pointer
to a function that can be used to generate the graph. This allows the
graph to be built based on information that might not be available yet at
parse time. This graph generation function has the following
signature:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">def</span> <span class="py-defname">generate_graph</span>(docindex, context, linker, *args):
<span class="py-more">... </span> <span class="py-string">'generates and returns a new DotGraph'</span></pre>
<p>Where <code>docindex</code> is a docindex containing the documentation
that epydoc has built; <code>context</code> is the <code>APIDoc</code>
whose docstring contains this dotgraph node; <code>linker</code> is a <a
href="epydoc.markup.DocstringLinker-class.html"
class="link">DocstringLinker</a> that can be used to resolve
crossreferences; and <code>args</code> is any extra arguments that are
passed to the <code>dotgraph</code> constructor.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.restructuredtext.dotgraph-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">generate_graph_func</span>,
<span class="summary-sig-arg">*generate_graph_args</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#dotgraph.__init__">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___50-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for___init___50-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for___init___50" name="call_graph_for___init___50">
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__init__()" alt="" coords="403,90,678,122" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#classtree_directive" title="classtree_directive()" alt="" coords="20,6,194,38" />
<area shape="rect" href="epydoc.markup.restructuredtext.dotgraph-class.html#__init__" title="__init__()" alt="" coords="258,90,354,122" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#digraph_directive" title="digraph_directive()" alt="" coords="24,62,190,94" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#importgraph_directive" title="importgraph_directive()" alt="" coords="7,118,207,150" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#packagetree_directive" title="packagetree_directive()" alt="" coords="8,174,206,206" />
</map>
<img src="call_graph_for___init___50.gif" alt='' usemap="#call_graph_for___init___50" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="graph"></a><span class="summary-sig-name">graph</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">docindex</span>,
<span class="summary-sig-arg">context</span>,
<span class="summary-sig-arg">linker</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#dotgraph.graph">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_graph-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_graph-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_graph" name="call_graph_for_graph">
<area shape="rect" href="epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#visit_dotgraph" title="_EpydocHTMLTranslator.visit_dotgraph()" alt="" coords="5,90,349,122" />
<area shape="rect" href="epydoc.markup.restructuredtext.dotgraph-class.html#graph" title="graph()" alt="" coords="399,90,473,122" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#_construct_classtree" title="_construct_classtree()" alt="" coords="536,6,723,38" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#_construct_digraph" title="_construct_digraph()" alt="" coords="540,62,719,94" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#_construct_importgraph" title="_construct_importgraph()" alt="" coords="523,118,736,150" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#_construct_packagetree" title="_construct_packagetree()" alt="" coords="524,174,735,206" />
</map>
<img src="call_graph_for_graph.gif" alt='' usemap="#call_graph_for_graph" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.image</code></b>:
<code>astext</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.Element</code></b>:
<code>__add__</code>,
<code>__delitem__</code>,
<code>__getitem__</code>,
<code>__iadd__</code>,
<code>__len__</code>,
<code>__radd__</code>,
<code>__repr__</code>,
<code>__setitem__</code>,
<code>__unicode__</code>,
<code>append</code>,
<code>attlist</code>,
<code>clear</code>,
<code>copy</code>,
<code>deepcopy</code>,
<code>delattr</code>,
<code>emptytag</code>,
<code>endtag</code>,
<code>extend</code>,
<code>first_child_matching_class</code>,
<code>first_child_not_matching_class</code>,
<code>get</code>,
<code>has_key</code>,
<code>hasattr</code>,
<code>index</code>,
<code>insert</code>,
<code>is_not_default</code>,
<code>non_default_attributes</code>,
<code>note_referenced_by</code>,
<code>pformat</code>,
<code>pop</code>,
<code>remove</code>,
<code>replace</code>,
<code>replace_self</code>,
<code>set_class</code>,
<code>setdefault</code>,
<code>shortrepr</code>,
<code>starttag</code>,
<code>update_basic_atts</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.Element</code></b> (private):
<code>_dom_node</code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.Node</code></b>:
<code>__nonzero__</code>,
<code>__str__</code>,
<code>asdom</code>,
<code>next_node</code>,
<code>setup_child</code>,
<code>traverse</code>,
<code>walk</code>,
<code>walkabout</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.Element</code></b>:
<code>child_text_separator</code>,
<code>list_attributes</code>,
<code>tagname</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.Node</code></b>:
<code>document</code>,
<code>line</code>,
<code>parent</code>,
<code>source</code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>docutils.nodes.Element</code></b>:
<code>attributes</code>,
<code>children</code>,
<code>rawsource</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">generate_graph_func</span>,
<span class="sig-arg">*generate_graph_args</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.restructuredtext-pysrc.html#dotgraph.__init__">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___50-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for___init___50-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for___init___50" name="call_graph_for___init___50">
<area shape="rect" href="javascript:void(0);" title="docutils.nodes.Element.__init__()" alt="" coords="403,90,678,122" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#classtree_directive" title="classtree_directive()" alt="" coords="20,6,194,38" />
<area shape="rect" href="epydoc.markup.restructuredtext.dotgraph-class.html#__init__" title="__init__()" alt="" coords="258,90,354,122" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#digraph_directive" title="digraph_directive()" alt="" coords="24,62,190,94" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#importgraph_directive" title="importgraph_directive()" alt="" coords="7,118,207,150" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#packagetree_directive" title="packagetree_directive()" alt="" coords="8,174,206,206" />
</map>
<img src="call_graph_for___init___50.gif" alt='' usemap="#call_graph_for___init___50" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<dl class="fields">
<dt>Overrides:
docutils.nodes.Element.__init__
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <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:04 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>
