在 RTD 服务器上发布时使用 Plantuml

Question

我刚刚设法在 RTD 服务器上显示我的文档。 (https://uracoli-rsensor.readthedocs.io/).

在 Sphinx-RST 文件中，我有一个“..uml::”语句，当我在本地构建文档时，它呈现得很好。

在 conf.py 中我有声明：

plantuml = 'java -jar plantuml.jar'

它引用了 plantuml.jar 的本地副本，该副本未提交到我的存储库。

如何为 readthedocs 正确编写语句 plantuml = ....？

Answer 1

最初的解决方案是在这里找到的： https://github.com/readthedocs/readthedocs.org/issues/3885

在 conf.py 添加这行：

if os.environ.get("READTHEDOCS") != None:
    plantuml = 'java -Djava.awt.headless=true -jar /usr/share/plantuml/plantuml.jar'
else:
    plantuml = 'java -jar plantuml.jar'

这里也有记录：

https://sphinxcontrib-needs.readthedocs.io/en/latest/installation.html#install-plantuml

在 RTD 服务器上发布时使用 Plantuml

Using Plantuml when publishing on RTD server

python-sphinx

plantuml

read-the-docs