sandbox/rst2graph/README

   1 .. -*- rst -*-
   2
   3 ====================
   4 README for rst2graph
   5 ====================
   6
   7 Overview
   8 ========
   9
  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.
  13
  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.
  17
  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.
  21
  22 Installation
  23 ============
  24
  25 After you obtained and unpacked the package run something like ::
  26
  27   python setup.py install
  28
  29 After installation you have the following commands to render graphs
  30 from reStructuredText:
  31
  32 **rst2graph.py**
  33   The generic renderer. You must give an explicit output format to
  34   this command.
  35
  36 **rst2gv.py**, **rst2dot.py**
  37   Two commands rendering to dot_ format.
  38
  39 **rst2gxl.py**
  40   A command to render GXL_ format.
  41
  42 Requirements
  43 ============
  44
  45 Beyond the docutils_ package you may want to install the pygraphviz_
  46 to render into dot_ output.
  47
  48 This runs on Python 2.7. Python 3 has not been tested.
  49
  50 Documentation
  51 =============
  52
  53 See http://www.merten-home.de/FreeSoftware/rst2graph/manual.html or
  54 use **--help** for options.
  55
  56 Tests
  57 =====
  58
  59 There are test suites in ``tests.tgz``. Use filterunit_ to run tests.
  60
  61 Availability
  62 ============
  63
  64 **rst2graph** is available from
  65
  66 http://www.merten-home.de/FreeSoftware/rst2graph/
  67
  68 and the Docutils sandbox
  69
  70 http://svn.code.sf.net/p/docutils/code/trunk/sandbox/rst2graph
  71
  72 History
  73 =======
  74
  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.
  79
  80 .. ###########################################################################
  81
  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