Tuesday, June 26, 2012

pythonbrew で Sphinx をインストール

python の Sphinx をドキュメント作成ツールとして使ってみることにしました。

Sphinx-Users.jp
http://sphinx-users.jp/

.rst 形式と pygments のシンタックスハイライトが気に入っていたので、あとは章立てができるツールを探して辿り着きました。Sphinx-Users.jp のサイトは、ドキュメント作成ツールのユーザグループだけあって、使い方の説明が簡潔ですばらしいです。.rst ソースを bitbucket や github に置けば、Wiki っぽい使い方ができるんじゃないかな?と思っているところです。

今回は pythonbrew を使って、python + Sphinx 環境を作ってみます。

pythonbrew
https://github.com/utahta/pythonbrew

ruby の rvm 同様、インストールスクリプトをダウンロードして bash で実行します。~/.pythonbrew にインストールされます。

% curl -kL http://xrl.us/pythonbrewinstall | bash
% ls ~/.pythonbrew
bin  build  dists  etc  log  patches  pythons  scripts  venvs

~/.bash_profile に ~/.pythonbrew/etc/bashrc があれば読み込むように追記します。

% vim ~/.bash_profile
...
[[ -s $HOME/.pythonbrew/etc/bashrc ]] && source $HOME/.pythonbrew/etc/bashrc
...

% source ~/.bash_profile

% which pythonbrew
~/.pythonbrew/bin/pythonbrew

次に pythonbrew で Python-2.7 をインストールしてみます。virtual-python とは違ってソースを持って来てビルドされます。

% pythonbrew list -k
...
Python-2.7.3
....
% pythonbrew install 2.7.3
....
% pythonbrew switch 2.7.3

% which python
~/.pythonbrew/pythons/Python-2.7.3/bin/python
% python -V
Python 2.7.3

# easy_install pip も合わせてインストールされます。
% which easy_install
~/.pythonbrew/pythons/Python-2.7.3/bin/easy_install
% which pip
~/.pythonbrew/pythons/Python-2.7.3/bin/pip

あとは easy_install で Sphinx をインストールして完了です。

% easy_install sphinx
....
% which sphinx-quickstart
~/.pythonbrew/pythons/Python-2.7.3/bin/sphinx-quickstart