summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-08-23 13:07:28 +0000
committerGeorg Brandl <georg@python.org>2010-08-23 13:07:28 +0000
commitb817147065b0c4116f19303412268d920e3e1230 (patch)
tree7ed7291a296d65e362905c1fbf076ca4e9087a34 /doc
parent988e61e6bbcf22ab64a535c1ae979c5197dc39c5 (diff)
downloadsphinx-b817147065b0c4116f19303412268d920e3e1230.tar.gz
#443: Allow referencing external graphviz files.
Diffstat (limited to 'doc')
-rw-r--r--doc/ext/graphviz.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/ext/graphviz.rst b/doc/ext/graphviz.rst
index 3741cec6..de6e03e2 100644
--- a/doc/ext/graphviz.rst
+++ b/doc/ext/graphviz.rst
@@ -29,6 +29,17 @@ It adds these directives:
:confval:`graphviz_output_format`). In LaTeX output, the code will be
rendered to an embeddable PDF file.
+ You can also embed external dot files, by giving the file name as an
+ argument to :rst:dir:`graphviz` and no additional content::
+
+ .. graphviz:: external.dot
+
+ As for all file references in Sphinx, if the filename is absolute, it is
+ taken as relative to the source directory.
+
+ .. versionchanged:: 1.1
+ Added support for external files.
+
.. rst:directive:: graph