PlantUML のコードを Sphinx ドキュメントに埋め込むための方法です。
ただし、Atom を使用したプレビュー機能が使えなくなるので、微妙かもしれません。
sphinxcontrib.plantuml のインストール
easy_install sphinxcontrib-plantuml
conf.py の設定
conf.py に以下の設定を追加します。
plantuml.jar のパスは適宜変更してください。
# sphinxcontrib.plantuml モジュールを読み込む extensions = ['sphinxcontrib.plantuml'] # PlantUML の起動方法を設定する plantuml = 'java -jar BAT/plantuml.jar'
尚、他のモジュールを読み込んでいる場合は、以下のように記述します。
extensions = ['rst2pdf.pdfbuilder','sphinxcontrib.plantuml']
記述方法
UML ディレクティブを使用して記述します。
.. uml:: Alice -> Bob: Hi! Alice <- Bob: How are you?
