使用Sphinx plantuml扩展在docstring中嵌入PlantUML图表。

Question

我安装了sphinxcontrib-plantuml扩展程序，如果我使用以下testmodule.rst文件运行HTML生成器，则可以正常工作，该文件对应于一个相应的testmodule.py文件：

testmodule module
=================

.. automodule:: testmodule
    :members:
    :undoc-members:
    :show-inheritance:

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

这将在文档的末尾添加UML图。不幸的是，我没有找到如何将UML图嵌入到文档中的任何位置，例如在方法docstring块的中间。

有人知道如何做吗？

- El tornillo

---

你尝试过在docstring中添加UML图吗？发生了什么事情？ - mzjn

Answer 1

将UML图表直接添加到文档字符串部分对我没有起作用。但是以下方式适用于我：

1. 将plantuml代码放在单独的文件中，例如diagram.uml：

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

2. 在文档字符串中的所需位置添加带有文件名的plantuml指令。例如：

def example():
    """
    some text

    .. uml:: diagram.uml

    some more text 
    """
    ...

- El tornillo