10 **rst2graph** is a program to create a graph from the links contained
11 in a reStructuredText file. This is useful if you use linking in your
12 text and want to visualize the link structure in a graphical form.
14 **rst2graph** supports various output formats describing the resulting
15 graph in a certain formal syntax. So far Graphviz_ seems to be the
16 best tool to render the output to a graphical form.
18 **rst2graph** offers a number of options to select only certain
19 portions from the reStructuredText file. Using these options you can
20 create the subgraph you are interested in.
25 After you obtained and unpacked the package run something like ::
27 python setup.py install
29 After installation you have the following commands to render graphs
30 from reStructuredText:
33 The generic renderer. You must give an explicit output format to
36 **rst2gv.py**, **rst2dot.py**
37 Two commands rendering to dot_ format.
40 A command to render GXL_ format.
45 Beyond the docutils_ package you may want to install the pygraphviz_
46 to render into dot_ output.
48 This runs on Python 2.7. Python 3 has not been tested.
53 See http://www.merten-home.de/FreeSoftware/rst2graph/manual.html or
54 use **--help** for options.
59 There are test suites in ``tests.tgz``. Use filterunit_ to run tests.
64 **rst2graph** is available from
66 http://www.merten-home.de/FreeSoftware/rst2graph/
68 and the Docutils sandbox
70 http://svn.code.sf.net/p/docutils/code/trunk/sandbox/rst2graph
75 **rst2graph** stems from **rst2gxl** which only supported the GXL_
76 format. Because the **gxl2gv** converter malfunctioned too often and
77 since pygraphviz_ is available **rst2gxl** became the foundation for
78 **rst2graph** supporting the dot_ format directly.
80 .. ###########################################################################
82 .. _Graphviz: http://graphviz.org/
83 .. _dot: http://www.graphviz.org/content/dot-language
84 .. _pygraphviz: http://networkx.lanl.gov/pygraphviz/
85 .. _filterunit: http://www.merten-home.de/FreeSoftware/filterunit/
86 .. _docutils: http://docutils.sourceforge.net/
87 .. _GXL: http://www.gupro.de/GXL