Sphinx + PlantUML、Windowsでの conf.py

導入に当たってさまざまのサイトを調べて以下のような記述を conf.py にしました。

conf.py(before)

extensions += ['sphinxcontrib.plantuml']
plantuml = ['java', '-jar', 'C:\Program Files (x86)\PlantUML\plantuml.jar']

これで動いていたのですが、PC を変えてから以下のようにしないと動作しませんでした。

conf.py(after)

extensions += ['sphinxcontrib.plantuml']
plantuml = '"C:\Program Files (x86)\Java\jre6\bin\java.exe" -jar "C:\Program Files\PlantUML\plantuml.jar" '

まず、配列ではなく文字列を渡すようにとのエラーが出ました。またこの環境には JRE の 6 と 8 が同居しているので、それもフルパスで指定しました。

このような設定例を書いてあるサイトは見かけなかったので、ここに記しておきます。

追記

もう面倒なので、コマンド（バッチ）を作って以下のようにしました。

conf.py(recent)

plantuml = '"C:\Program Files\PlantUML\plantuml.bat" '

plantuml.bat

@ECHO off

::
:: PlantUML Execute
::

SET GRAPHVIZ_DOT="C:\Program Files (x86)\Graphviz2.38\bin\dot.exe"

SET CONFIG_FILE="C:\Program Files\PlantUML\config.txt"
SET PLANTUML_JAR="C:\Program Files\PlantUML\plantuml1.2017.15.jar"

java -jar %PLANTUML_JAR% -config %CONFIG_FILE% -charset UTF-8 %*