« Publickeyにて、メールインタビュー記事が公開 | トップページ | sphinx-quickstart コマンドで設定した内容 »

Sphinxとの出会いとインストール

Wordで作成されたわりとボリュームのある文書をHTMLにしたいと思っていたので、開発部が使っているツールを教えてもらいました。彼らはチュートリアルなど製品を使うための説明資料を作成するためにツールを探して、使うようになったそうです。

Sphinx v1.0
Python Documentation Generator

プログラムを書く方ならだいたいご存知であろう渋川よしきさんが、日本語サイトを運営していて詳しい解説があります。Sphinxで検索すると紹介の記事や使っている方のブログや、渋川さんのチュートリアル(Slideshare)など、たくさん見つかりますので、使い始めやすいツールです。

私は業務でプログラムを書くことはほぼありません。このブログを書く時にHTMLのタグをほんの少し触るくらいで、Pythonは全く知りませんし、普段はWordやExcelやメーラーで仕事をしています。でも、あちこち検索して記事を読んだら、インストールできましたし、HTMLも生成できました。使ってみていいなぁと思ったので、デベロッパーではない人がやってみるとどうなるのか書いてみます。

インストールで参考にしたサイト
Pythonって何?という人のためのSphinxインストール入門

PCのOSは、Windows XP SP3なので、まずはPythonをインストールしました。Python公式サイトのHOMEには、Quick Linkで 2.7や3.1.2の新しいバージョンがありますが、Sphinxを使うためには 2.6系が必要だそうです。私は3.1.2をインストールした後で、Sphinxをインストールできず開発メンバに聞いてやり直しました。
Windows用、Pythonの前バージョン

記事にある通り、STEP1で環境変数にパスを追記します。
1. [スタート]-[コントロールパネル]を選択し、「システム」をダブルクリックして、プロパティの画面を開きます。
2. 「詳細設定」タブをクリックし、下部にある「環境変数」ボタンを押下します。
3. 私は「ユーザー環境変数」のPATHと、「システム環境変数」のPathの両方で、末尾に "C:\Python26;C:\Python26\Scripts" を追記しました。 4. 「OK」ボタンをクリックして、システムのプロパティ画面に戻り、もう一度「OK」ボタンを押下します。

あとは、[スタート]-[すべてのプログラム]-[アクセサリ]-[コマンドプロンプト]を起動して、STEP2、STEP3のコマンドを実行していきます。ここまでやってから Sphinxの設定を聞いたので、それは次回に。

ちなみに終わってから気づきましたが、インストールの手順はSphinxの日本ユーザ会のサイトにも掲載されています。こちらには Python 3系では動作しないことが書いてありますので、内容が更新されているようです。
Sphinx-Users.jp
Windowsへのインストール

|

« Publickeyにて、メールインタビュー記事が公開 | トップページ | sphinx-quickstart コマンドで設定した内容 »

Sphinx」カテゴリの記事

コメント

コメントを書く



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


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



トラックバック

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

この記事へのトラックバック一覧です: Sphinxとの出会いとインストール:

« Publickeyにて、メールインタビュー記事が公開 | トップページ | sphinx-quickstart コマンドで設定した内容 »