この前のブログのエントリーにも書きましたが、Sphinxというステキすぎるツールがあります。ドキュメントがどんどん書きたくなっちゃうステキなツールです。ですが、残念ながら、使用するためにはインストールする必要があります。Pythonって何？という人には少々敷居が高いため、解説の記事を書いてみました。
[STEP 1] Pythonからインストールする場合
WindowsではPythonからインストールする必要があります。一発でインストールできる環境を持っている人は最後の方のインストール法に飛んでください。また、Mac OS Xみたいに、最初からPythonから入っている人は[STEP 1]は飛ばしてください。
Windwsの場合
http://python.orgを開きます。Pythonの総本山です。恐れないで行きましょう！左側のサイドバーから、Quick Links(2.6.2)の中のWindows Installerをクリックしてダウンロードして、インストールします。
後は通常、良くあるようなインストーラが起動しますので、そのままインストールしてください。
初期設定のままインストールすると、C:\Python26\以下にインストールされます。環境変数の設定を開き、C:\Python26;C:\Python26\Scriptsを追加してください。追加したくない場合には、各コマンドの実行例のコードサンプルの場合は、python.exeとあれば、C:\Python26\python.exe などと、適宜読み替えてください。
「名前を指定して実行」でcmdと入力するか、コマンドプロンプトを起動して、pythonと入力したら、 >>> で何か入力させる画面が出ます。これはインタラクティブモードと呼びますが、これが表示されていればインストールは大丈夫です。CTRL+Zで抜けてください。
[STEP2]easy-installをインストール
Pythonにはeasy-installという便利なコマンドがあります。何かインストールしたいプログラムやライブラリがあったとすると、コマンドを一つ入力するだけで、実行するのに必要なものも一緒にダウンロードしてくれます。まずは下記のファイルをダウンロードします。コマンドラインでeasy-install.exeと入力してみて、返事があればこのSTEPは飛ばすことができます。
http://peak.telecommunity.com/dist/ez_setup.py上記のリンクを右クリックして保存します。URLを開くと、ブラウザによってはそのままダウンロードできます。ファイルの中身が見えても、おちついて、右クリックで保存をすれば大丈夫です。
ダウンロードしたら、コマンドラインを起動し、該当のファイルのあるところまで移動してから、以下のように実行します。
> python ez_setup.pyこれでeasy_installコマンドがインストールされます。ここまで行けば次はとうとうSphinxです。
[STEP3]Sphinxのインストール
setuptoolsまでインストールされていれば、後は一瞬です。コマンドラインから以下のようにタイプします。
> easy_install sphinxこれで完了です。
[その他]一発でインストールできる場合
Ubuntu Linux
Ubuntuは標準のパッケージシステムに設定されていますので、以下のコマンド一発でインストールできます。
$ sudo apt-get install python-sphinx
簡単でしょう？
MacPortsの場合
$ sudo port install py26-sphinx
とタイプします。一瞬ですね。
Sphinxが入ったら？
コマンドラインから以下のようにタイプします。
> sphinx-quickstartいくつか質問に答えると様々なファイルができます。後はファイルを書いたり、追加したりして、ちょくちょくmakeとコマンドプロンプトでタイプすると、きれいにフォーマットされたドキュメントが作成されます。書き方については、またブログ書くかも。細かい使い方、使えるコマンド、reStructuredTextの基本などは、僕が翻訳した、http://sphinx-users.jp/doc10/(Sphinx 1.0リリースにあわせてドキュメントのURLも変わっています。)を参照してください。
