Sublime text 2でSphinxを使う

最近、評判のSublime Text 2とSphinxを使ってドキュメントを書いて見たのでおぼえがきの意味も含めメモ

事前準備

Sublime text 2のインストール

公式サイト(http://www.sublimetext.com/)から該当のOSのパッケージをダウンロードし、インストールを行う。

インストールが完了後、定番のPackage Contorolを入れる。

インストールからPackage Contorolを入れるまでの手順は以下のサイトを参考に行なった。

Sublime Text 2がプログラミング人生を変えるかも知れない
　http://tak0303.github.com/2012/09/25/how-to-use-sublime.html

Sphinxのインストール

公式サイト(http://sphinx-users.jp/)のチュートリアルを元に

　・Python3.2のインストール(お好みのバージョンでOK)
　・Setuptool(Easy_Install)をインストール
　・Easy_InstallからSphinxをインストール

一応、動作確認の為、コマンドプロンプトからsphinx-quickstartを実行

正常に動作すれば準備完了。

Sublime text 2のパッケージインストール

sphinxをSublime text 2で動かす為にパッケージのインストール入れたパッケージが

　・Restructured Text (RST) Snippets
　・Markdown Preview

最低限必要なパッケージは、これぐらい。ぶっちゃけ、なくても問題はない。

build環境の構築

さて、ここからが本題。
build環境の為,メニューの中にある

[Tools] - [Build System] - [New Build System...]

を選択し、開いたファイルに以下のコードを入れてファイルを保存する。(ファイル名は、sphinx.sublime-buildとかにする。)

これで準備完了なのでドキュメントを書いたら、さきほどのメニュー内に新たにsphinxの項目が追加されているので

[Tools] - [Build System] - [sphinx]

を選んだ後に、ctrl + b でbuildが開始される。

ビルド前に確認したい時は、Markdown Previewを使い確認をする。
(PreferrencesのKey Bindings-userに起動用のショートカットコマンドを登録しておくと便利)

あとはお好みでGitで管理をするなりすればOK!