epydoc.markup.restructuredtext.dotgraph

Package epydoc :: Package markup :: Module restructuredtext :: Class dotgraph

Class dotgraph
source code

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:

>>> def generate_graph(docindex, context, linker, *args):
...     'generates and returns a new DotGraph'

Where docindex is a docindex containing the documentation that epydoc has built; context is the APIDoc whose docstring contains this dotgraph node; linker is a DocstringLinker that can be used to resolve crossreferences; and args is any extra arguments that are passed to the dotgraph constructor.

Instance Methods	[hide private]

__init__(self, generate_graph_func, *generate_graph_args)

graph(self, docindex, context, linker)

Inherited from docutils.nodes.image: astext

Inherited from docutils.nodes.Element: __add__, __delitem__, __getitem__, __iadd__, __len__, __radd__, __repr__, __setitem__, __str__, __unicode__, append, attlist, copy, delattr, emptytag, endtag, extend, first_child_matching_class, first_child_not_matching_class, get, get_children, has_key, hasattr, index, insert, pformat, pop, remove, replace, set_class, setdefault, shortrepr, starttag

Inherited from docutils.nodes.Element (private): _dom_node

Inherited from docutils.nodes.Node: __nonzero__, asdom, setup_child, walk, walkabout

Class Variables	[hide private]

Inherited from docutils.nodes.TextElement: child_text_separator

Inherited from docutils.nodes.Element: tagname

Inherited from docutils.nodes.Node: document, line, parent, source

Method Details	[hide private]

init(self, generate_graph_func, generate_graph_args)
(Constructor)*

source code

Overrides: docutils.nodes.TextElement.__init__

graph(self, docindex, context, linker)

source code

Class dotgraph source code

__init__(self, generate_graph_func, *generate_graph_args) (Constructor)

graph(self, docindex, context, linker)

Class dotgraph
source code

init(self, generate_graph_func, generate_graph_args)
(Constructor)*