<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>sphinx.ext.graphviz – Add Graphviz graphs — Sphinx 1.1.3 documentation</title>
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.1.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Sphinx 1.1.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Sphinx 1.1.3 documentation" href="../index.html" />
<link rel="up" title="Sphinx Extensions" href="../extensions.html" />
<link rel="next" title="sphinx.ext.inheritance_diagram – Include inheritance diagrams" href="inheritance.html" />
<link rel="prev" title="Math support in Sphinx" href="math.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<img src="../_static/sphinx.png" alt="Sphinx logo" />
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="inheritance.html" title="sphinx.ext.inheritance_diagram – Include inheritance diagrams"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="math.html" title="Math support in Sphinx"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Sphinx home</a> | </li>
<li><a href="../contents.html">Documentation</a>
»</li>
<li><a href="../extensions.html" accesskey="U">Sphinx Extensions</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="math.html"
title="previous chapter">Math support in Sphinx</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="inheritance.html"
title="next chapter"><tt class="docutils literal"><span class="pre">sphinx.ext.inheritance_diagram</span></tt> – Include inheritance diagrams</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/ext/graphviz.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-sphinx.ext.graphviz">
<span id="sphinx-ext-graphviz-add-graphviz-graphs"></span><h1><a class="reference internal" href="#module-sphinx.ext.graphviz" title="sphinx.ext.graphviz: Support for Graphviz graphs."><tt class="xref py py-mod docutils literal"><span class="pre">sphinx.ext.graphviz</span></tt></a> – Add Graphviz graphs<a class="headerlink" href="#module-sphinx.ext.graphviz" title="Permalink to this headline">¶</a></h1>
<p class="versionadded">
<span class="versionmodified">New in version 0.6.</span></p>
<p>This extension allows you to embed <a class="reference external" href="http://graphviz.org/">Graphviz</a> graphs in
your documents.</p>
<p>It adds these directives:</p>
<dl class="directive">
<dt id="directive-graphviz">
<tt class="descname">.. graphviz::</tt><a class="headerlink" href="#directive-graphviz" title="Permalink to this definition">¶</a></dt>
<dd><p>Directive to embed graphviz code. The input code for <tt class="docutils literal"><span class="pre">dot</span></tt> is given as the
content. For example:</p>
<div class="highlight-rest"><pre>.. graphviz::
digraph foo {
"bar" -> "baz";
}</pre>
</div>
<p>In HTML output, the code will be rendered to a PNG or SVG image (see
<a class="reference internal" href="#confval-graphviz_output_format"><tt class="xref std std-confval docutils literal"><span class="pre">graphviz_output_format</span></tt></a>). In LaTeX output, the code will be
rendered to an embeddable PDF file.</p>
<p>You can also embed external dot files, by giving the file name as an
argument to <a class="reference internal" href="#directive-graphviz" title="graphviz directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">graphviz</span></tt></a> and no additional content:</p>
<div class="highlight-rest"><pre>.. graphviz:: external.dot</pre>
</div>
<p>As for all file references in Sphinx, if the filename is absolute, it is
taken as relative to the source directory.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 1.1: </span>Added support for external files.</p>
</dd></dl>
<dl class="directive">
<dt id="directive-graph">
<tt class="descname">.. graph::</tt><a class="headerlink" href="#directive-graph" title="Permalink to this definition">¶</a></dt>
<dd><p>Directive for embedding a single undirected graph. The name is given as a
directive argument, the contents of the graph are the directive content.
This is a convenience directive to generate <tt class="docutils literal"><span class="pre">graph</span> <span class="pre"><name></span> <span class="pre">{</span> <span class="pre"><content></span> <span class="pre">}</span></tt>.</p>
<p>For example:</p>
<div class="highlight-rest"><pre>.. graph:: foo
"bar" -- "baz";</pre>
</div>
</dd></dl>
<dl class="directive">
<dt id="directive-digraph">
<tt class="descname">.. digraph::</tt><a class="headerlink" href="#directive-digraph" title="Permalink to this definition">¶</a></dt>
<dd><p>Directive for embedding a single directed graph. The name is given as a
directive argument, the contents of the graph are the directive content.
This is a convenience directive to generate <tt class="docutils literal"><span class="pre">digraph</span> <span class="pre"><name></span> <span class="pre">{</span> <span class="pre"><content></span> <span class="pre">}</span></tt>.</p>
<p>For example:</p>
<div class="highlight-rest"><pre>.. digraph:: foo
"bar" -> "baz" -> "quux";</pre>
</div>
</dd></dl>
<p class="versionadded">
<span class="versionmodified">New in version 1.0: </span>All three directives support an <tt class="docutils literal"><span class="pre">alt</span></tt> option that determines the image’s
alternate text for HTML output. If not given, the alternate text defaults to
the graphviz code.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.1: </span>All three directives support an <tt class="docutils literal"><span class="pre">inline</span></tt> flag that controls paragraph
breaks in the output. When set, the graph is inserted into the current
paragraph. If the flag is not given, paragraph breaks are introduced before
and after the image (the default).</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.1: </span>All three directives support a <tt class="docutils literal"><span class="pre">caption</span></tt> option that can be used to give a
caption to the diagram. Naturally, diagrams marked as “inline” cannot have a
caption.</p>
<p>There are also these new config values:</p>
<dl class="confval">
<dt id="confval-graphviz_dot">
<tt class="descname">graphviz_dot</tt><a class="headerlink" href="#confval-graphviz_dot" title="Permalink to this definition">¶</a></dt>
<dd><p>The command name with which to invoke <tt class="docutils literal"><span class="pre">dot</span></tt>. The default is <tt class="docutils literal"><span class="pre">'dot'</span></tt>; you
may need to set this to a full path if <tt class="docutils literal"><span class="pre">dot</span></tt> is not in the executable
search path.</p>
<p>Since this setting is not portable from system to system, it is normally not
useful to set it in <tt class="docutils literal"><span class="pre">conf.py</span></tt>; rather, giving it on the
<strong class="program">sphinx-build</strong> command line via the <em class="xref std std-option">-D</em> option should be
preferable, like this:</p>
<div class="highlight-rest"><pre>sphinx-build -b html -D graphviz_dot=C:\graphviz\bin\dot.exe . _build/html</pre>
</div>
</dd></dl>
<dl class="confval">
<dt id="confval-graphviz_dot_args">
<tt class="descname">graphviz_dot_args</tt><a class="headerlink" href="#confval-graphviz_dot_args" title="Permalink to this definition">¶</a></dt>
<dd><p>Additional command-line arguments to give to dot, as a list. The default is
an empty list. This is the right place to set global graph, node or edge
attributes via dot’s <tt class="docutils literal"><span class="pre">-G</span></tt>, <tt class="docutils literal"><span class="pre">-N</span></tt> and <tt class="docutils literal"><span class="pre">-E</span></tt> options.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-graphviz_output_format">
<tt class="descname">graphviz_output_format</tt><a class="headerlink" href="#confval-graphviz_output_format" title="Permalink to this definition">¶</a></dt>
<dd><p>The output format for Graphviz when building HTML files. This must be either
<tt class="docutils literal"><span class="pre">'png'</span></tt> or <tt class="docutils literal"><span class="pre">'svg'</span></tt>; the default is <tt class="docutils literal"><span class="pre">'png'</span></tt>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.0: </span>Previously, output always was PNG.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="inheritance.html" title="sphinx.ext.inheritance_diagram – Include inheritance diagrams"
>next</a> |</li>
<li class="right" >
<a href="math.html" title="Math support in Sphinx"
>previous</a> |</li>
<li><a href="../index.html">Sphinx home</a> | </li>
<li><a href="../contents.html">Documentation</a>
»</li>
<li><a href="../extensions.html" >Sphinx Extensions</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2007-2011, Georg Brandl.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
distrib
>
Mageia
>
4
>
i586
>
media
>
core-release
>
by-pkgid
>
c95717a2237548a7bdaddf39c85b0f0f
>
files
>
105
