2011年10月28日

Windows上でCodeigniterのユーザガイドをMakeする手順


個人的にCodeigniterの配布元(Repository)がMercuryからGitHubに移ったのは非常にありがたいんですが、ユーザガイドがSphinxとやらに移行したのはだいぶいただけないです。
GitHubのソースにはSphinx用のファイルが入ってるだけで、ユーザガイドを見たいならHTMLファイルを生成しないといけないらしい。面倒すぎる・・・
HTMLで配布してくれたままだったら楽だったのに・・・どうやらSphinxってもともとPythonの文書生成のためのものらしいですね。

だいぶ面倒だったのでSphinx用のソースファイルからHTMLファイルを生成するまでの手順を以下にメモしておきます。


Pythonのインストール
まず、WindowsにPythonをインストールします。
前述のとおりPHPなのになぜかPython用の文書生成アプリを使ってるので、Windowsには標準装備されてないPythonのインストールからやらないといけない。
Pythonを既にインストールしてる人はこの手順をスキップしてください。

Pythonバージョン2系をダウンロード。
3系はダメ(だそうです)。

Windows用のインストーラをダウンロードした場合はそのままインストール。
必須ではないですが、インストールが完了したら環境変数にPythonのパスを追加しておくと便利です。

環境変数への登録(XP)
コントロールパネル→システム→詳細設定→環境変数
Pathを選択してPythonのパスを追加。

eg) C:\Python27\;C:\Python27\Scripts;


登録が終わったらコマンドプロンプトで python と入力すれば確認できます。


easy-installをインストール
ez_setup.pyをダウンロード、コマンドラインで python ez_setup.py と入力すると勝手にインストールしてくれます(以下同文)。


Sphinxをインストール
コマンドラインで easy_install sphinx と入力。

Sphinxの設定
コマンドラインで sphinx-quickstart と入力すると会話形式の設定画面が表示されます。
基本的にEnterで進んで行って問題ないです。わかる人は変更してください。
'Project Name', 'Version Number','Author'が必須項目なので適当に。


sphinxcontrib-phpdomainをインストール
コマンドラインで easy_install sphinxcontrib-phpdomain と入力。


CI Lexer をインストール
Gitでコピーしたファイルの中に user_guide_src というフォルダがあるので、コマンドプロンプトで移動します。
さらにその中に cilexer があるので移動。
python setup.py install と入力。
インストールが終わったら pygmentize -L | more と入力して以下の記述があるか確認します。あればインストール完了。
* ci, codeigniter:
    CodeIgniter (filenames *.html, *.css, *.php, *.xml, *.static)


HTMLファイルを作成
上述 user_guide_src フォルダの中に source フォルダがあるので今度はこちらに移動。
make html と入力すると _build フォルダが作成されます。更にその中に doctrees, html とフォルダが作成され、そのうち html が作成されたユーザガイドです。
この html フォルダをコピー(もしくはカット)して Codeigniter のトップに貼り付け user_guide とフォルダ名を変更すれば完了。


ほんっと、お疲れさまでした!!
 

0 件のコメント:

コメントを投稿