erlang-domainを使ってみた。
Sphinx 1.0 からドメイン機能*1が追加されましたが、@shibukawaさんが、erlang-domain*2を公開されたので使ってみました。
erlang-domainを使うことで、きれいにマークアップされたErlangドキュメントを書くことができます。
1. まずは、インストールから
$ easy_install -ZU sphinx
$ easy_install -ZU sphinxcontrib-erlangdomain
2. クイックスタートでSphinxプロジェクトを作成します。
3. conf.py に、sphinxcontrib-erlangdomainの設定をする。
# Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinxcontrib.erlangdomain']
本家にもコミットされたようで、別途インストールせずに利用することもできるようになるはずです。
http://bitbucket.org/birkenfeld/sphinx-contrib/changesets
*1:ドメイン機能 http://sphinx-users.jp/doc10/domains.html
*2:sphinxcontrib-erlangdomain http://pypi.python.org/pypi/sphinxcontrib-erlangdomain/0.1dev-20100827
第7回 Python温泉 1日目
例のごとく、Python温泉に参加しています。
ドキュメント作成時に、バージョンごとやドキュメントの種類で
ソース(reST)のディレクティブを抜き出す方法を探していますが、
あまりいい方法は無いようです。
Sphinxでは、拡張機能ifconfigを使うことで、バージョンやドキュメントの種類で表示のon/offを切り替えられます。
1. conf.py で、'sphinx.ext.ifconfig'を追加する。
2. ソースのディレクティブを設定する。conf.py の versionが'1.0a'の婆愛だけ表示される。
.. ifconfig:: version in ('1.0a')
この内容は開発版('1.0a')でビルドした場合のみ、ドキュメントの中に展開されます。
3. make する。
pydictionを使う
普段は補完機能を使うことがあまりないですが、簡単に使えそうなプラグインがあったので使い方など。
pydictionは、作成済みの辞書ファイルからキーワード補完をしてくれるプラグインです。
インストールは、プラグインファイルをプラグインディレクトリへコピーするだけです。
辞書ファイルはどこでも良いですが、.vimディレクトリに入れておく方が管理しやすそうです。
$ unzip pydiction-1.2.zip
$ cp pydiction-1.2/python_pydiction.vim ~/.vim/plugin/.
$ mv pydcition-1.2 ~/.vim/.
最後に、 .vimrc へ設定を追加します。
if has("autocmd")
autocmd FileType python set complete+=k~/.vim/pydiction-1.2/complete-dict iskeyword+=.,(
endif
この手順でプラグインが利用できます。
こういったプラグインは、辞書の登録がめんどうですが、pydictionはモジュールを指定するだけで
辞書ファイルを更新できるスクリプトが同梱されています。
PYTHONPATHが通っていれば、次の例のようにモジュール名を指定するだけで更新できます。
辞書ファイルは、カレントディレクトリにある必要があります。
$ python pydiction.py jinja2
reSTでreadbleな改行を入れるには
日本語を書いていて、センテンスの途中に改行を入れたくなったときに
「\」を入れることで変換時に改行されるようですが、ラインブロックを使うほうがスマートです。
行の先頭に、「|」が入っちゃいますが、「\」よりはマシかと。
ふつうに改行をいれるとき
あいうえお かきくけこ さしすせそ
ラインブロック利用時
あいうえお かきくけこ さしすせそ
参考サイト:
http://docutils.sourceforge.net/docs/user/rst/quickref.html#line-blocks
和訳:
http://www.planewave.org/translations/rst/quickref.html
現在のポスト数 62 / 100
Python温泉
第6回 Python温泉に参加中です。
buildbotを調査してます、
@shimizukawa さんにいろいろと教わって、入門編は突破した感じです。
http://www.freia.jp/taka/blog/679
現在のポスト数 61 / 100
VMWare Fusion のゲストOSへ払い出すIPを固定する
以下のサイトを参考にしてできました。
要バックアップ。
http://d.hatena.ne.jp/cariandrum22/20090410/1239322081
http://d.hatena.ne.jp/shuji_w6e/20090624/1245845814
現在のポスト数 60 / 100