2012年9月19日水曜日

[IntelliJ IDEA]Sphinx を使う

IntelliJ IDEA で Sphinx にて reST を変換して HTML 出力するまで。

■Sphinx のインストール
まず、easy_install をインストールします。
Mac なら次。
参考 http://d.hatena.ne.jp/buta9999/20120329/1333028463

$ curl -O http://python-distribute.org/distribute_setup.py
$ sudo python distribute_setup.py

Windows ならdistribute_setup.py をブラウザとかでDLして これを実行で。

(一応、Mac は virtualenv 環境あるので workon しとく。)
次に、sudo easy_install sphinx で依存含めてインストール。

Mac なら which sphinx-quickstart ができる、
Windows なら where shinx-quickstart ができれば正常にインストールできてます。

■sphinx-quickstart

適当に sphinx のプロジェクトレベルの設定ファイルやらソースファイルやらアウトプットやらをおくディレクトリを作ってあらかじめそこに移動。

sphinx-quickstart してプロジェクト名、作者、バージョンくらいを入力して他デフォルトOKしとく。

■IntelliJ IDEA で インポート
Create project from existing sources でさっき作ったディレクトリのパスを指定して python でプロジェクトを作る。

■ビルドの設定
Edit Configurations で Python docs -> Sphinx task を選択。


次に、Command 、Input、Output 適宜入力。


これで準備OK.

あとは makeすればできる。

■mac の場合の補足
http://memo.yomukaku.net/entries/UaLbzhE

XCode のインストールと Command Line Tools をインストールする。
gcc -v か which gcc と which make でインストール確認。

これインストールしとかないと make コマンドがたたけない。

■自分メモ
IntelliJ IDEA で virtualenv したかったらSDKの設定で普通に virtualenv 環境のパス配下にある Python へのシンボリックリンク「/Users/zono/.virtualenvs/path/hogehoge/python」みたいなのを使えばいい。

すると IntelliJ IDEA が次みたいな感じでsite-packeges も自動でロードしてくれた。
file:///Users/zono/.virtualenvs/sphinx/lib/python2.7/site-packages/*.egg

あと、隠しフォルダがもし見えないときは ln -s /Users/zono/.virtualenvs/sphinx/ /Users/zono/sphinxenv とかって適当にシンボリックリンク作るとなんとかなる。

NameError: Cannot find sphinx in selected interpreter.

こんなエラーになったときは、IntelliJ IDEA のプロンプトに表示される
/Users/zono/.virtualenvs/sphinx/bin/python "/Users/zono/Library/Application Support/IntelliJIdea11/python/helpers/rest_runners/sphinx_runner.py" -b html /Users/zono/sphinxdocs/zonote /Users/zono/sphinxdocs/zonote/_build
みたいなのを確認しよう。
私の場合はシステムの python になっちゃっていたので、Edit Configurations で実行する python を virtualenvs 配下のものに変更したら正常に動作した。

IntelliJ IDEA で無理やり?かはわかりませんが、virtualenv も問題ないのでどんどん virtualenv 環境を作っちゃいましょう。
もちろん、 virtualenvwrapper 使います。


0 件のコメント:

コメントを投稿