gpt4 book ai didi

python-sphinx - 在文档字符串中的某处嵌入 plantuml 图(使用 Sphinx plantuml 扩展名)

转载 作者:行者123 更新时间:2023-12-04 08:25:11 27 4
gpt4 key购买 nike

我安装了 sphinxcontrib-plantuml 扩展,如果我运行 HTML 构建器,它可以正常工作,例如对于相应的 testmodule.py 文件,使用以下 testmodule.rst 文件:

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

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

.. uml::

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

这会在文档的最后添加 UML 图。不幸的是,我没有找到如何在文档中的任何地方嵌入 UML 图,例如在方法文档字符串 block 中间的某处。

有人知道怎么做吗?

最佳答案

直接在文档字符串部分添加 UML 图对我不起作用。但以下对我有用:

  1. 将 plantuml 代码放在单独的文件中,例如图.uml:
@startuml
Alice -> Bob: Hi!
Alice <- Bob: How are you?
@enduml
  1. 在文档字符串中的所需位置添加带有文件名的 plantuml 指令。例如:
def example():
"""
some text

.. uml:: diagram.uml

some more text
"""
...

关于python-sphinx - 在文档字符串中的某处嵌入 plantuml 图(使用 Sphinx plantuml 扩展名),我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/65303386/

27 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com