：模式：sphinx.ext.graphviz–添加Graphviz图¶

Added in version 0.6.

此插件允许嵌入’Graphviz<https://graphviz.org/>`_文档中的图表。

它添加了以下指令：

.. graphviz::¶

用于嵌入graphviz代码的指令。“点”的输入代码作为内容给出。例如：：

.. graphviz::

   digraph foo {
      "bar" -> "baz";
   }

在HTML输出中，代码将呈现为PNG或SVG图像（请参见：confval:graphviz_output_format）。在LaTeX输出中，代码将呈现为可嵌入的PDF文件。

也可以通过将文件名作为参数嵌入外部点文件：rst:方向：`graphviz`且没有其他内容：：

.. graphviz:: external.dot

对于Sphinx中的所有文件引用，如果文件名是绝对的，则将其视为相对于源目录的。

在 1.1 版本发生变更: 添加了对外部文件的支持。

选项

:alt: alternate text (text)¶: 图形的替代文本。默认情况下，图形代码用于替换文本。

Added in version 1.0.

:align: alignment of the graph (left, center or right)¶: 图形的水平对齐。

Added in version 1.5.

:caption: caption of the graph (text)¶: 图表的标题。

Added in version 1.1.

:layout: layout type of the graph (text)¶: 图形的布局（例如“点”、“neato”等等）。也允许graphviz命令的路径。默认情况下，使用：confval:`graphviz_dot’。

Added in version 1.4.

在 2.2 版本发生变更: 从“graphviz”dot重命名``

:name: label (text)¶: 图形的标签。

Added in version 1.6.

:class: class names (a list of class names separated by spaces)¶: 图形的类名。

Added in version 2.4.

.. graph::¶

用于嵌入单个无向图的指令。名称作为指令参数给定，图形的内容是指令内容。这是生成``graph 1 {2} ``的便利指令。

例如：

.. graph:: foo

   "bar" -- "baz";

备注

图形名被原封不动地传递给Graphviz。如果它包含非字母数字字符（如破折号），则必须双引号。

选项

和rst:dir:graphviz.一样

:alt: alternate text (text)¶: Added in version 1.0.

:align: alignment of the graph (left, center or right)¶: Added in version 1.5.

:caption: caption of the graph (text)¶: Added in version 1.1.

:layout: layout type of the graph (text)¶: Added in version 1.4.

在 2.2 版本发生变更: 从“graphviz”dot重命名``

:name: label (text)¶: Added in version 1.6.

:class: class names (a list of class names separated by spaces)¶: 图形的类名。

Added in version 2.4.

.. digraph::¶

用于嵌入单个有向图的指令。名称作为指令参数给定，图形的内容是指令内容。这是生成“有向图{}`”的方便指令。

例如：

.. digraph:: foo

   "bar" -> "baz" -> "quux";

选项

和rst:dir:graphviz.一样

:alt: alternate text (text)¶: Added in version 1.0.

:align: alignment of the graph (left, center or right)¶: Added in version 1.5.

:caption: caption of the graph (text)¶: Added in version 1.1.

:layout: layout type of the graph (text)¶: Added in version 1.4.

在 2.2 版本发生变更: 从“graphviz”dot重命名``

:name: label (text)¶: Added in version 1.6.

:class: class names (a list of class names separated by spaces)¶: 图形的类名。

Added in version 2.4.

还有以下配置值：

graphviz_dot¶

用于调用“dot”的命令名。默认值为“dot”；如果“dot”不在可执行搜索路径中，则可能需要将其设置为完整路径。

由于此设置在系统之间不可移植，因此通常设置它是没有用的``配置文件``；相反，在：program:sphinxbuild`命令行中通过：option:-D`选项给出它应该更可取，如下所示：

sphinx-build -M html -D graphviz_dot=C:\graphviz\bin\dot.exe . _build

graphviz_dot_args¶: 以列表形式提供给dot的其他命令行参数。默认为空列表。这是通过dot的`-G``、-N``和-E``选项设置全局图、节点或边缘属性的正确位置。

graphviz_output_format¶

生成HTML文件时Graphviz的输出格式。它必须是“png”或“svg”；默认值为“png”。如果使用了“svg”，为了使URL链接正常工作，必须设置适当的“target”属性，例如“top”和“blank”。例如，下图中的链接应该在svg输出中起作用：：：

.. graphviz::

     digraph example {
         a [label="sphinx", href="https://www.sphinx-doc.org/", target="_top"];
         b [label="other"];
         a -> b;
     }

Added in version 1.0: 以前，输出总是PNG。

Sphinx

On this page

Site navigation

：模式：sphinx.ext.graphviz–添加Graphviz图¶