Docutils (インストール)

Docutilsは、ドキュメントを記述し、様々なフォーマットで出力することができる便利なツールです(インストールの詳細はこちら):

  1. docutilsの配布物をsrc/にあるファイルで置き換えてください。
  2. 使用例とPlantUMLのデフォルトのセットアップ方法については、usage/をご確認ください。

使用法

"uml"ディレクティブを使って、PlantUMLコマンドのインデントブロックを記述してください。引数は不要です。画像が生成され、その場所に挿入されます。ファイル名は行番号から生成されます。PlantUMLのソースが同一フォルダに生成されます。

.. uml::

actor User
participant "First Class" as A
participant "Second Class" as B
participant "Last Class" as C

User -> A: DoWork
activate A

オプションのパラメータとして、画像のファイル名(拡張子を除く)を指定することができます。

.. uml:: uml2/myDiagram123

actor User
participant "First Class" as A
participant "Second Class" as B
participant "Last Class" as C

User -> A: DoMoreWork
activate A


Privacy Policy      Advertise