Использование Plantuml при публикации на RTD-сервере - PullRequest
0 голосов
/ 17 апреля 2020

Мне только что удалось вывести свою документацию на RTD-сервер. (https://uracoli-rsensor.readthedocs.io/).

В файле Sphinx-RST у меня есть оператор ".. uml ::", который прекрасно отображается при локальной сборке документации.

В conf.py У меня есть заявление:

plantuml = 'java -jar plantuml.jar'

Это ссылка на локальную копию plantuml.jar, которая не передана в мой репо.

Как мне написать заявление plantuml = .... правильно для readthedocs?

1 Ответ

1 голос
/ 18 апреля 2020

Исходное решение было найдено здесь: 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

...