plantuml-sphinx 0.30

安装

pip install sphinxcontrib-plantuml

用法

将 sphinxcontrib.plantuml 添加到你的 conf.py 文件中的扩展列表

extensions = [
    'sphinxcontrib.plantuml',
]

你也可以在 conf.py 中指定 plantuml 命令

plantuml = 'java -jar /path/to/plantuml.jar'

相反，你可以在你的 PATH 中安装一个包装脚本

% cat <<EOT > /usr/local/bin/plantuml
#!/bin/sh -e
java -jar /path/to/plantuml.jar "$@"
EOT
% chmod +x /usr/local/bin/plantuml

然后，在 .. uml:: （或 .. plantuml::） 指令下写入 PlantUML 文本

.. uml::

   Alice -> Bob: Hi!
   Alice <- Bob: How are you?

或指定外部 PlantUML 文件的路径

.. uml:: external.uml

您可以指定 height、width、scale 和 align

.. uml::
   :scale: 50 %
   :align: center

   Foo <|-- Bar

您还可以指定标题

.. uml::
   :caption: Caption with **bold** and *italic*
   :width: 50mm

   Foo <|-- Bar

有关详细信息，请参阅PlantUML 文档。

配置

plantuml

plantuml 可执行文件路径。（默认：‘plantuml’）

plantuml_output_format

HTML 渲染器的输出图像类型。（默认：‘png’）

png:

仅在

svg:

在

svg_img:

仅在 浏览器支持）

svg_obj:

仅在 浏览器支持）

none:

不生成任何图像（忽略 uml 指令）

当SVG位于