忍者ブログ

雑記

sphinxのインストール

雑記 > codeのメモ > sphinxのインストール

sphinxインストール方法

Windows Subsystem for Linux環境を想定

sphinx自体のインストールは以下のコマンド

sudo apt-get install python-sphinx

sphinxのブロック図生成ツール

sphinxを使う理由の一つとしてはブロック図、シーケンス図が楽に書けるというのがあると思う。 ブロック図生成用のツールは別途インストールが必要。

blockdiagのインストール

ブロック図生成ツール blockdiagのインストールは以下のコマンド

pip install sphinxcontrib-actdiag sphinxcontrib-blockdiag sphinxcontrib-nwdiag sphinxcontrib-seqdiag

準備としてconf.pyの編集も必要。以下の内容の追加が必要。


extensions = [
  'sphinxcontrib.blockdiag' ,
  'sphinxcontrib.seqdiag'   ,
  'sphinxcontrib.actdiag'   ,
  'sphinxcontrib.nwdiag'    ,
  'sphinxcontrib.rackdiag'  ,
  'sphinxcontrib.packetdiag',
]
blockdiag_html_image_format  = 'SVG'
seqdiag_html_image_format    = 'SVG'
actdiag_html_image_format    = 'SVG'
nwdiag_html_image_format     = 'SVG'
rackdiag_html_image_format   = 'SVG'
packetdiag_html_image_format = 'SVG'

ブロック図内で日本語を使うにはフォントパスの設定が必要でこれもconf.pyで設定する。

Windows Subsystem for Linux環境ではWindowsのフォントが使用できる。パス、設定例は以下の通り。 ブロック図、シーケンス図、アクティビティ図、ネットワーク図それそれで設定が必要。


blockdiag_fontpath = '/mnt/c/Windows/Fonts/meiryo.ttc'
seqdiag_fontpath   = '/mnt/c/Windows/Fonts/msgothic.ttc'
actdiag_fontpath   = '/mnt/c/Windows/Fonts/msgothic.ttc'
nwdiag_fontpath    = '/mnt/c/Windows/Fonts/msgothic.ttc'

ブロック図生成ツールの使い方の詳細は ブロック図生成ツール blockdiag のHPを参照。

pipのエラー

自分が実施したときにpip実行時に以下の様なエラーが発生した。(20180713)


Traceback (most recent call last):
  File "/usr/bin/pip", line 9, in 
    from pip import main
ImportError: cannot import name main

あまりLinuxなど詳しくないので適当だが、一応以下の手段でpipを実行できるようになった。

sudo python -m pip uninstall pip
sudo apt-get install pip --upgrade pip

コメント

カレンダー

07 2018/08 09
S M T W T F S
2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30 31