sandbox/rst2graph/rst2graph.rst

   1 =========
   2 rst2graph
   3 =========
   4
   5 ---------------------------------------------------------
   6 generate graphs from the links in a reStructuredText file
   7 ---------------------------------------------------------
   8
   9 :Author: smerten@oekonux.de
  10 :Copyright: GPL v2
  11 :Manual section: 1
  12 :Manual group: text processing
  13
  14 SYNOPSIS
  15 ========
  16
  17 **rst2graph.py** **--dot|--gv|--gxl** [*options*\]... [*reST* [*graph*\]]
  18
  19 **rst2dot.py** [*options*\]... [*reST* [*dot-graph*\]]
  20
  21 **rst2gv.py** [*options*\]... [*reST* [*dot-graph*\]]
  22
  23 **rst2gxl.py** [*options*\]... [*reST* [*gxl-graph*\]]
  24
  25 DESCRIPTION
  26 ===========
  27
  28 Translates a reStructuredText_ document to a graph in various
  29 languages. This can then be transformed to a graphic for instance by
  30 Graphviz_.
  31
  32 OPTIONS
  33 =======
  34
  35 .. include:: docutilsOptions.rst
  36
  37 SEE ALSO
  38 ========
  39
  40 .. _Docutils:
  41
  42 * Docutils
  43
  44   http://docutils.sourceforge.net/
  45
  46 .. _reStructuredText:
  47
  48 * reStructuredText
  49
  50   http://docutils.sourceforge.net/rst.html
  51
  52 .. _GXL:
  53
  54 * GXL
  55
  56   http://www.gupro.de/GXL
  57
  58 .. _Graphviz:
  59
  60 * Graphviz
  61
  62   http://graphviz.org/
  63
  64 AVAILABILITY
  65 ============
  66
  67 **rst2graph** is available from
  68
  69 http://www.merten-home.de/FreeSoftware/rst2graph/
  70
  71 and the Docutils sandbox
  72
  73 http://svn.code.sf.net/p/docutils/code/trunk/sandbox/rst2graph