Sphinx ER Diagram Extention
インストール
Graphvizの導入
本拡張はGraphvizを利用しています。 そのため、別途、Graphvizを入手しインストールを実施してください。
拡張のインストール
続いて、pipでモジュールのインストールを行います。
pip install sphinx_erdiagramビルドの設定
conf.pyにて、拡張の設定を記述します。
sphinx.ext.graphviz拡張 で利用できるプロパティを使用することができます。
extensions = ['myasuda.sphinx.erdiagram']
graphviz_output_format = "svg" #出力形式を指定します。(Defaultではpng)graphviz_dotプロパティ
dotを呼び出すときに使用するコマンド名を指定できます。デフォルトでは 'dot' となります。
このプロパティは異なる環境で共通で利用できないため、通常、conf.pyの中で設定しません。
以下のように、sphinx-buildコマンドの -D オプションとして利用します。
sphinx-build -b html -D graphviz_dot=C:\graphviz\bin\dot.exe . _build/htmlRequirements
- Python 3.5
- Graphviz 2.38
- Sphinx 1.4
