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)

source code
call graph

graph(self, docindex, context, linker)

source code
call graph

Inherited from docutils.nodes.image: astext

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

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

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

Class Variables

[hide private]

Inherited from docutils.nodes.Element: child_text_separator, list_attributes, tagname

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

Instance Variables

[hide private]

Inherited from docutils.nodes.Element: attributes, children, rawsource

Method Details

[hide private]

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

source code
call graph

Overrides: docutils.nodes.Element.__init__

Class dotgraph

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

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