summaryrefslogtreecommitdiff
path: root/sandbox/rst2graph/rst2graph.rst
blob: 5743d8a5c4db34594412d959de0979db63957d5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
=========
rst2graph
=========

---------------------------------------------------------
generate graphs from the links in a reStructuredText file
---------------------------------------------------------

:Author: smerten@oekonux.de
:Copyright: GPL v2
:Manual section: 1
:Manual group: text processing

SYNOPSIS
========

**rst2graph.py** **--dot|--gv|--gxl** [*options*\]... [*reST* [*graph*\]]

**rst2dot.py** [*options*\]... [*reST* [*dot-graph*\]]

**rst2gv.py** [*options*\]... [*reST* [*dot-graph*\]]

**rst2gxl.py** [*options*\]... [*reST* [*gxl-graph*\]]

DESCRIPTION
===========

Translates a reStructuredText_ document to a graph in various
languages. This can then be transformed to a graphic for instance by
Graphviz_.

OPTIONS
=======

.. include:: docutilsOptions.rst

SEE ALSO
========

.. _Docutils:

* Docutils

  http://docutils.sourceforge.net/

.. _reStructuredText:

* reStructuredText

  http://docutils.sourceforge.net/rst.html

.. _GXL:

* GXL

  http://www.gupro.de/GXL

.. _Graphviz:

* Graphviz

  http://graphviz.org/

AVAILABILITY
============

**rst2graph** is available from

http://www.merten-home.de/FreeSoftware/rst2graph/

and the Docutils sandbox

http://svn.code.sf.net/p/docutils/code/trunk/sandbox/rst2graph