maisumakun / ci_user_guide_src

CodeIgniter ユーザーガイド

セットアップ手順

CodeIgniterのユーザガイドは、ドキュメントを管理するためにSphinxを使用し、 様々なフォーマットに変換しています。 ページは人間が読める ReStructured Text フォーマットで書かれています。

前提条件

SphinxはPythonが必要です。OSXの場合は既にインストールされています。 試しにターミナルで python を実行してみてください。 上手くいけば、どのバージョンがインストールされているかが表示されます。 2.7+でない場合は、以下のURLから2.7.2をインストールしてください。 http://python.org/download/releases/2.7.2/

インストール

1. easy_install をインストール
2. easy_install "sphinx==1.2.3"
3. easy_install sphinxcontrib-phpdomain
4. CI Lexer をインストールして、コードサンプルで PHP、HTML、CSS、Javascript がシンタックスハイライトされるようにする (cilexer/README を参照)
5. cd user_guide_src
6. make html

ドキュメントの編集と作成

すべてのソースファイルは source/ の下にあり、 ここでドキュメントを追加修正します。 コードの変更と同様に、フィーチャーブランチで作業を行い、 develop ブランチにプルリクエストを送ることをお勧めします。

HTMLは？

ユーザーがまず参照するであろうHTML版ドキュメントは、 私たちが最も関心を持つものです。 ビルドされたファイルの差分は不要なのでソース管理下に置いていません。 必要に応じてあなたの作業中のファイルをプレビューすることもできます。 HTMLの生成は簡単です。あなたの手元にあるユーザーガイドレポジトリのルートディレクトリで、 インストール手順の最後と同じコマンドを実行してください。

make html

目を見張るようなコンパイルが行われ、レンダリングされたユーザガイドと画像が build/html/ に置かれます。 一度ビルドが成功すれば、 その後は変更されたファイルのみが再ビルドされるので、時間の短縮になります。 もし何らかの理由でビルドファイルを「リセット」したい場合は、 build フォルダの内容を削除して再ビルドしてください。

スタイルガイドライン

SphinxでCodeIgniterのドキュメントを作成する際のスタイルガイドは source/documentation/index.rst を参照してください。