« 講演のご案内、楽天テクノロジーカンファレンス2010 | トップページ | toctreeって何だ? »

Sphinx、index.rstを makeしてみる

sphinx-quickstart コマンドを実行して、作成するドキュメントの置き場所(プロジェクトと呼ばれます)ができたら、ひとまずファイルを makeしてみました。

何をしたか書く前に、今、渋川さんのサイト(http://sphinx.shibu.jp/)を見たところ、先週まではなかった注意が追加されていました。こちらのサイトは少し前の文書を訳したもので、最新のドキュメントを見たい方は Sphinx-Users.jp のSphinxドキュメントを確認してほしいそうです。

Sphinx 1.1 documentation

さて、Sphinxでドキュメントを作成していく時に、元のファイルの拡張子は「.rst」が基本になります。quickstartで「.txt」も選択できますが、「.rst」を意識して何かすることはほぼないので、私はそのままにしておきました。「.rst」をメモ帳(UTF-8で保存できるテキストエディタなら何でも良いそうです)で開いてみると、開発者ではない私には「.txt」と同じに見えました。

前回作成した「manual」というフォルダを開くと、sourceと buildというフォルダができています。
sourceは、HTMLページの元になる「.rst」ファイルを格納するフォルダです。
buildは、「source」フォルダにある「.rst」ファイルや画像ファイルを元にして、makeコマンドで生成されたHTMLファイルが格納されるフォルダです。

「source」フォルダには 「index.rst」というファイルができていますので、これをビルド(makeコマンドを実行する)して、表示用のHTMLファイルを生成してみましょう。

  1. [Windowsスタート]-[アクセサリ]-[コマンドプロンプト]を起動
  2. Sphinxのプロジェクトフォルダに移動
    通常、コマンドプロンプトを起動すると、ユーザーホームと呼ばれるフォルダに位置しています。
    Windows XPでは、「C:\Documents and Settings\ユーザ名」です。
  3. cd コマンドを使って、Sphinxのプロジェクトフォルダへ移動します。
    プロジェクトのフォルダが、Cドライブの直下に「manual」という名前である場合は、
    cd ../../manual
    と入力してEnterキーを押下します。
  4. 「C:\manual>」と表示されますので、その後に「make html」を入力してEnterキーを押下します。
  5. Build finished. The HTML pages are in build/html
    この文が表示されればビルドは完了です。

build フォルダの中に、htmlフォルダがあり、そこにある index.html がビルド(make htmlコマンド)によって生成されたHTMLファイルです。今回は index.rst に何も追記せずHTMLを生成したため、こんな感じのHTMLになりました。

Sphinxsample

これから「source」ファイルに、rstファイルを追加していき、make htmlコマンド実行を繰り返すことで、ドキュメントの元ファイル作成とHTML表示確認を繰り返すことができます。

|

« 講演のご案内、楽天テクノロジーカンファレンス2010 | トップページ | toctreeって何だ? »

Sphinx」カテゴリの記事

コメント

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.f.cocolog-nifty.com/t/trackback/98967/37215514

この記事へのトラックバック一覧です: Sphinx、index.rstを makeしてみる:

« 講演のご案内、楽天テクノロジーカンファレンス2010 | トップページ | toctreeって何だ? »