CodeIgniter のユーザガイドをビルドするために Sphinx をインストールする

CodeIgniter Sphinx

CodeIgniter のユーザガイドが Sphinx に移行しました。

ここでは、CodeIgniter のリポジトリから HTML のユーザガイドを生成する方法を解説します。

なお、CodeIgniter を Web アプリの開発に使用するだけの場合、Sphinx は必要ありません。今後もリリースパッケージには HTML のユーザガイドが含まれます。また、開発中のリポジトリのユーザガイドを HTML 化したもの(毎日更新)が、以下から閲覧できます。

Sphinx とは？

Python で書かれたドキュメンテーションツールです。

easy_install をインストールする

Ubuntu では以下のようにします。easy_install は Python のインストールツールです。

$ sudo apt-get install python-setuptools

Sphinx をインストールする

Ubuntu では以下のようにします。Mac OS X でも同じだと思います。

$ sudo easy_install sphinx
$ sudo easy_install sphinxcontrib-phpdomain

CI Lexer をインストールする

CodeIgniter のリポジトリ https://github.com/EllisLab/CodeIgniter の user_guide_src/cilexer/ にある CI Lexer をインストールします。

$ cd cilexer
$ sudo python setup.py install

正しくインストールされたことを確認します。

$ pygmentize -L | grep CodeIgniter
    CodeIgniter (filenames *.html, *.css, *.php, *.xml, *.static)

HTML をビルドする

リポジトリの user_guide_src/ に移動し make します。

$ make html

これで、build/html/ 以下に HTML ファイルが生成されます。

参考

関連