スポンサーサイト

-------- --:--:-- --

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

【sphinx】Sphixを使いはじめてみた

2012-02-28 01:49:45 Tue

■sphinxって何?


ここ見たらだいたいわかります。
http://sphinx-users.jp/

わかってるからそう言うのでしょうか。
はじめはまったくわかりませんでした。

要は、テキストファイルにwiki記法みたいな簡易マークアックアップの「reStructredText」で
記述し、これをプログラムを使って綺麗なHTMLなどにする、ということです。

で、「reStructredText」はディレクティブというのがあって、
これを使ってブロック図を書いたりシーケンス図を書いたり、
「reStructredText」標準の機能に機能追加していく感じです。

Sphinxというとpython、
という感じですがpythonを知らないとsphinxを使えないことはまったくありません。

知らないといけないのは、「reStructredText」の記述方法とSphinxの使い方です。

■sphinxインストール


ではさっそくインストールします。
pythonのインストールはexeキックするだけです。
easy_installはこのへんを参考にして下さい。

http://sphinx-users.jp/gettingstarted/install_windows.html

easy-install sphinx


これだけです。

■プロジェクトを作る



sphinx-quickstart


質問には全部デフォルトで答えました。

以下だけ入力します。


  • プロジェクト名

  • バージョン番号

  • 著者の名前



■diagインストール


http://blockdiag.com/ja/blockdiag/introduction.html#id2

easy_install pillow
easy_install blockdiag



■sphinxにdiagを埋め込む


上記だけでsphinxでblockdiagを使えるわけじゃなく、
上記はテキストファイル「diag」などからpng形式の画像データを作成するものです。
埋め込むには「sphinxcontrib-blockdiag」が必要です。

easy_install sphinxcontrib-blockdiag



■confの設定



./sphinx-project/conf.py
# Enabled extensions
extensions = ['sphinxcontrib.blockdiag']

# Fontpath for blockdiag (truetype font)
blockdiag_fontpath = 'C:\Windows\Fonts\msgothic.ttc'

ちょっとpythonファイルに設定を追記します。
pythonファイルもただのテキストファイルです。

■ディレクティブ



.. blockdiag:: [diag-filename]


例えばこんな感じで使えるようになります。

■トライアンドエラー的な…



  • blockdiagのpngファイルで日本語が文字化け

    これは文字化け、なんだけれど要はデフォルトでは日本語フォント使ってなくて、
    変なUTF-8の文字見つかったけどなににしたらわからーん!って状態。

    rem set /P font=フォントのパスを指定して下さい。(日本語フォントがよい):
    set font="C:\Windows\Fonts\msgothic.ttc"
    set /P diag=diagファイルのパスを指定して下さい。:
    blockdiag -f %font% %diag%
    pause


    こうやって日本語フォント指定してやればいける。
    でもちょっとノード内のフォントが上きれるんだよな…。これ原因不明です。

  • Sphinxのドキュメントで日本語が文字化け

    これも上と同じような問題。
    結局CSSのfont-familyの記述によって読み込まれているフォントが日本語非対応のフォントということらしい。

    http://blog1.erp2py.com/2012/01/sphinx.html
    <転載>

    [Pythonフォルダ] → [Lib] → [site-packages] → [Sphinx-1.1.2-py2.7.egg] → [sphinx]
    sphinxdoc.css_t ファイルをコピー&ペーストする

    [sphinx] → [themes] → [sphinxdoc] → [static] フォルダーに sphinxdoc.css_t ファイルがあるのでコピーして、ドキュメントの [_static] フォルダに貼り付ける。

    ペーストした sphinxdoc.css_t ファイルをテキストエディタで開き、font-family を変更する。

    sphinxdoc.css_t には font-family の指定が4カ所あるので変更する。私は次のように変更した。

    bodyタグ指定、viewcode-backクラス指定

    変更前
    font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
    'Verdana', sans-serif;
    変更後
    font-family: 'Arial', 'Helvetica', sans-serif;

    cite, code, ttタグ指定、preタグ指定

    変更前
    font-family: 'Consolas', 'Deja Vu Sans Mono',
    'Bitstream Vera Sans Mono', monospace;
    変更後
    font-family: 'Consolas', 'Courier New', monospace;
    make html コマンドで、htmlファイルを再作成する。

    Lucida Grandeとか悪さをしているみたいです。>


  • スポンサーサイト

⇒comment

Secret

名言集
全記事(数)表示
全タイトルを表示
ブログ内検索
Loading
上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。