graphviz 插件¶

备注

本插件是 graphviz 格式的图片在sphinx的支持

配置文件修改:

# 通过配置开启graphviz插件
extensions = ['sphinx.ext.graphviz']

# 设置 graphviz_dot 路径
graphviz_dot = 'dot'
# 设置 graphviz_dot_args 的参数，这里默认了默认字体
# 过-G, -N, -E 来设置全局的 graph、node、edge 属性(注意是单引号)
graphviz_dot_args = ['-Gfontname=Georgia',
                     '-Nfontname=Georgia',
                     '-Efontname=Georgia']
# 输出格式，默认png，这里我用svg矢量图
graphviz_output_format = 'svg'

使用1-基本:

.. graphviz::

  digraph abc{
      a;
      b;
      c;
      d;

      a -> b;
      b -> d;
      c -> d;
  }

使用1-文件:

.. graphviz:: external.dot

https://img.zhaoweiguo.com/knowledge/images/sphinxdocs/sphinx-docs-with-graphviz1.png

参考¶

sphinx 文档使用 graphviz 来画图: https://www.chenyudong.com/archives/sphinx-docs-draw-graphic-with-graphviz.html