2009年09月11日

Pythonって何?という人のためのSphinxインストール入門

sphinx

この前のブログのエントリーにも書きましたが、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をクリックしてダウンロードして、インストールします。

installpython

後は通常、良くあるようなインストーラが起動しますので、そのままインストールしてください。

installpython

初期設定のままインストールすると、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も変わっています。)を参照してください。

posted by @shibukawa at 00:52 | Comment(174) | TrackBack(4) | Python はてなブックマーク - Pythonって何?という人のためのSphinxインストール入門
この記事へのトラックバックURL
http://blog.sakura.ne.jp/tb/32044108
※ブログオーナーが承認したトラックバックのみ表示されます。

この記事へのトラックバック

Pythonって何?という人のためのSphinxチュートリアル
Excerpt: インストールができたら、今度は使い方のチュートリアルです。実際にSphinxでの作業の流れをお見せしたいと思います。
Weblog: 渋日記
Tracked: 2009-09-13 11:22

Pythonって何?という人のためのSphinxチュートリアル[2]
Excerpt: さて、それではSphinxならではのディレクティブをいくつか使っていきます。また、それ以外にも、前回ので書き忘れたreSTなんかも補足していきます。
Weblog: 渋日記
Tracked: 2009-09-21 19:40

とちぎRuby会議02 - その1(LT)
Excerpt: とちぎRuby会議02がありました!普段は技術や「普及するには?」ということについて語られることが多いIT系イベントですが、仕事としてのマインドについて多くのメッセージを聞くことができました。今回..
Weblog: 渋日記
Tracked: 2009-10-25 11:35

Google App Engineを試す
Excerpt: Google App Engineの使い方を解説したサイトが増えてきた。 タグ「gae」を含む新着エントリー - はてなブックマーク すぐに始められる方法が紹介さ...
Weblog: 浜村拓夫の世界
Tracked: 2010-02-11 21:44
検索ボックス

Twitter

www.flickr.com
This is a Flickr badge showing public photos and videos from shibukawa.yoshiki. Make your own badge here.
<< 2016年06月 >>
      1 2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30    
最近の記事
カテゴリ
過去ログ
Powered by さくらのブログ