« Sphinxとの出会いとインストール | トップページ | 講演のご案内、楽天テクノロジーカンファレンス2010 »

sphinx-quickstart コマンドで設定した内容

Sphinxをインストールした後は、実際に作成したい文書のためにいくつか設定します。コマンドを実行して、ちょっとした質問にYes、Noやユーザー名やフォルダ名を回答(入力)するだけです。

参考にしたページ
slideshareで公開されている渋川さんのチュートリアル
たのしいドキュメンテーション

1. OSがWindows XPの方は、[Windowsスタート]-[すべてのプログラム]-[アクセサリ]-[コマンドプロンプト]を開きます。
2. 右向きの > の表示に続いて、sphinx-quickstart と入力します。
3. 上記リンクのスライド6枚目にあるように、プロジェクト名(ドキュメントを作っていくフォルダ名です)、著者名(自分の名前でOK)、バージョン番号(適当な数字)の三点以外は、全部 Enterキーを押していくだけでも構いません。

ただ、作り始めてみるとテキストファイルを置くフォルダと、ビルド(コマンドを実行すると、作ったテキストファイルを元に表示用のファイルを作ってくれる)結果のファイルが生成されるフォルダが同じだと、ファイルが混乱して不便なことが分かりました。作業しているフォルダ(sourceという名前になります)と、結果のフォルダ(buildという名前)は別になっている方が、単純に分かりやすいです。
そのため、quickstartで設定したフォルダを丸ごと削除して、もう一度 quickstart コマンドを実行しました。

回答した質問とその内容
これら以外はEnterキーを押すだけでした。

  • > Separate source and build directories (y/N) [n]:
    y を入力
  • > Project name:
    manual と入力
  • > Author name(s):
    自分の名前を入力
  • > Project version:
    ひとまず 0.1としました
  • > Project release [0.1]:
    何も入力しなくても、Project versionで入力した数字が自動で入っています

sphinx-quickstart コマンドでの設定が終わると、「manual」というフォルダと、その中に「source」というフォルダができています。

感じたこと: アンインストールではなくて、フォルダを丸ごと削除して、もう一度やり直せば新しい(全く別の)作業用フォルダを作れるのもいいところです。

他にも参考になるページ(Sphinx-Users.jp の解説)
プロジェクトを作る
sphinx-quickstartの詳細説明

|

« Sphinxとの出会いとインストール | トップページ | 講演のご案内、楽天テクノロジーカンファレンス2010 »

Sphinx」カテゴリの記事

コメント

コメントを書く



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


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



トラックバック

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

この記事へのトラックバック一覧です: sphinx-quickstart コマンドで設定した内容:

« Sphinxとの出会いとインストール | トップページ | 講演のご案内、楽天テクノロジーカンファレンス2010 »