CodeIgniter4のユーザガイドをビルドする post

この記事は CodeIgniter Advent Calendar 2020 - Qiita の11日目です。まだ、空きがありますので、興味のある方は気軽に参加してください。

macOS 10.15.7 で CodeIgniter4 のユーザガイドをビルドできるようにしてみます。

ユーザガイドは Sphinx を使って管理されています。

以下を参考にします。

CodeIgniter4 リポジトリの取得

CodeIgniter4 の開発リポジトリがない場合は、git clone してください。

$ git clone https://github.com/codeigniter4/CodeIgniter4.git
$ cd CodeIgniter4
$ composer install

必要なツールの確認

Python 3.5 以上が必要です。

$ python3 --version
Python 3.9.0
$ pip3 --version
pip 20.2.4 from /usr/local/lib/python3.9/site-packages/pip (python 3.9)

問題ありません。

インストール

以下のコマンドを実行すると必要なものがインストールされます。

$ pip3 install -r user_guide_src/requirements.txt

以下のパッケージがインストールされました。

Successfully installed Jinja2-2.11.2 MarkupSafe-1.1.1 Pygments-2.7.3 alabaster-0.7.12 babel-2.9.0 certifi-2020.12.5 chardet-3.0.4 docutils-0.16 idna-2.10 imagesize-1.2.0 packaging-20.7 pyparsing-2.4.7 pytz-2020.4 requests-2.25.0 snowballstemmer-2.0.0 sphinx-2.4.4 sphinx-rtd-theme-0.5.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-phpdomain-0.7.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.4 urllib3-1.26.2

ユーザガイドのビルド

make html コマンドを実行し、ビルドしてみます。

$ cd user_guide_src
$ make html
Sphinx v2.4.4 を実行中
ビルド中 [mo]: 更新された 0 件のpoファイル
ビルド中 [html]:更新された 153 件のソースファイル
環境データを更新中[新しい設定] 153 件追加, 0 件更新, 0 件削除
ソースを読み込み中...[  0%] changelogs/index                                    ...
更新されたファイルを探しています... 見つかりませんでした
環境データを保存中... 完了
整合性をチェック中... 完了
preparing documents... 完了
出力中...[  0%] changelogs/index                                                ...
generating indices...  genindex完了
writing additional pages...  search完了
画像をコピー中... [ 12%] installation/../images/welcome.png                     ...
静的ファイルをコピー中... ... 完了
copying extra files... 完了
dumping search index in English (code: en)... 完了
dumping object inventory... 完了
ビルド 成功.

HTMLページはbuild/htmlにあります。

ビルド成功しました。

ブラウザで開いてみます。

今日の日付でビルドされています。

$ open build/html/index.html

CodeIgniter4 のユーザガイドの URL

CodeIgniter4 のユーザガイドの URL は 2つあって、リリース版(執筆時点では 4.0.4)の公式は以下です。

開発版のユーザガイドは以下になります。

この記事は CodeIgniter Advent Calendar 2020 - Qiita の11日目です。まだ、空きがありますので、興味のある方は気軽に参加してください。

参考

Date: 2020/12/11

Tags: codeigniter, codeigniter4, sphinx