Verified details These details have been verified by PyPI Maintainers yuja Unverified details These details have not been verified by PyPI Project links Homepage Download GitHub Statistics Installation pip install sphinxcontrib-plantuml Usage Add sphinxcontrib.plantuml to your extensions list in your conf.py: extensions = [ 'sphinxcontrib.plantuml', ] You may also need to specify the plantuml comm
Doxygen You can use Doxygen and PlantUML together to integrate UML diagrams into generated documentation. You will find more information in the official documentation.
Sphinx には Sphinx 拡張(Sphinx extension)と呼ばれるプラグイン機能があります。 Sphinx 拡張を使うとドキュメントを書くのがより便利になったり、 ドキュメントの表現がより豊富になったりします。 今日はその Sphinx 拡張の中から僕がよく使うもの、便利そうで使ってみたいものを それぞれいくつかピックアップしてご紹介します。 sphinx.ext.todo Sphinx に同梱されている拡張モジュールで、ドキュメントに ToDo を書き残すことができます。 有効にするには conf.py に以下の記述を追加します。 # sphinx.ext.todo モジュールを読み込む extensions += ['sphinx.ext.todo'] # ToDo 項目を表示する (デフォルトは表示しない; False) todo_include_todos = T
はじめに 目次 戻る はじめに_ テキストから UML を生成する PlantUMLを用いてUML図を描く。 参考URLは以下のとおり。 PlantUML(英語) プログラマーズ雑記帳:PlantUML の使い方 UMLの用語は基本的にマーチン・ファウラー著: UML モデリングのエッセンス 第3版, 翔泳社, 2005年にしたがう。 目次_ インストール Windows 7上にPlantUMLをインストール Ubuntu上にPlantUMLをインストール UML図の作成 PlantUMLでクラス図を描く PlantUMLでオブジェクト図を描く PlantUMLシーケンス図を描く PlantUMLでパターン図を描く PlantUMLで配置図を描く PlantUMLでユースケース図を描く PlantUMLで状態マシン図を描く PlantUMLでアクティビティ図を描く 戻る_ Yuichi G
PlantUML でのダイアグラムの見栄えを変更する skinparam について説明します。 @startuml{plantuml_skinparam_sample.png} skinparam backgroundColor #EEEBDC skinparam sequence { ArrowColor DeepSkyBlue ActorBorderColor DeepSkyBlue LifeLineBorderColor blue LifeLineBackgroundColor #A9DCDF ParticipantBorderColor DeepSkyBlue ParticipantBackgroundColor DodgerBlue ParticipantFontName Impact ParticipantFontSize 17 ParticipantFontColor #A9
クラス図の例 クラスボックス もっともシンプルなクラス図 属性と操作が記載されたクラス プロパティ、属性と関連 関連 プロパティを属性で表した場合 プロパティを関連で表した場合 誘導可能性矢印 汎化 依存関係 戻る クラス図の例_ マーチン・ファウラー著 UMLモデリングのエッセンス 第3版 図3.1をPlantUMLで描くと以下のようになる。 上記のクラス図は以下のPlantUML記法で生成される。 Fig3.1.puml(テキストファイル) ' マーチン・ファウラー著 UMLモデリングのエッセンス 第3版 図3.1 @startuml{Fig3.1.png} title 簡単なクラス図 class "Order (注文)" as Order { dateReceived: Date [0..1] isPrepaid: Boolean [1] number: String [1] pri
@startuml{plantuml_class_specclass.png} enum FigureType { FigureType_unknown=-1 FigureRect FigurePolygon FigureEllipse } abstract Figure class Rect interface Comparable { {abstract} int compare(Comparable *other) } Figure <|-- Rect Rect .|> Comparable @enduml スポットとステレオタイプ シーケンス図と同様にクラス定義の後にステレオタイプを書く事ができます。 また、ステレオタイプで C, I, A, E 以外のスポットを指定することができます。 class クラス名 <<(スポット文字, 色) [ステレオタイプ名]>> @startuml
JQuery integration Imagine that you could directly use PlantUML source code into HTML, something like: And that will display this: This would be nice. Well, using JQuery library, this will work. You just have to use the following header in your html file: <head> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="[[jquery_plantuml.js|jquery_plantuml.js]]"><
テキストから UML を生成する PlantUML についての解説記事を書いてみました。 PlantUML の使い方 (今回) シーケンス図 クラス図 オブジェクト図 パッケージ図 ユースケース図 アクティビティ図 状態遷移(ステートマシン)図 コンポーネント図 配置図 skinparam PlantUML 実行用のバッチファイル 今回は PlantUML の使い方の説明です。 PlantUML とは インストール 日本語 コマンドライン Doxygen との連携 Doxygen 連携用スクリプト その他のツールとの連携 オンラインデモ PlantUML とは 最近、プログラムの設計書などで UML を使うのが浸透してきていますが、 この UML を書くのはわりと面倒です。 CASE ツール, Doxygen などでは、クラス図を自動生成してくれますが、 ユースケース図やシーケンス図は自分
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く