Cara menggunakan User Guide CodeIgniter 4 di komputer lokal

Sebelumnya mungkin teman-teman terlebih dulu belajar tentang instalasi CI, namun yang tak kalah penting menurut saya adalah tentang bagaimana instalasi User Guide nya di komputer lokal kita.

Untuk teman-teman yang akses internetnya 24/7 mungkin ndak bakal jadi masalah ketika harus membuka user guide onlien terus menerus, akan tetapi untuk teman-teman lain yang masih terkendala dengan jaringan internet, menginstall user guide di komputer lokal akan sangat memudahkan ketika kita belajar atau pun solving problem.

Langsung saja, kita masuk ke pembahasan. Ketika kita meng-clone project CI dari GitHub atau unzip project CI didalamnya kita akan mendapatkan folder user_guide_src. Namun, didalamnya tidak terdapat file html, sehingga kita tidak bisa membaca atau menggunakan user guide seperti ketika kita melihat di online.

Kalau kita baca di readme nya, kita dapati info:

The CodeIgniter user guide uses Sphinx to manage the documentation and
output it to various formats. Pages are written in human-readable
ReStructured Text <http://sphinx.pocoo.org/rest.html>_ format.

Karena itu kita memang tidak bisa langsung melihat isinya. Namun jangan khawatir, kita bisa melakukan build terhadap dokumennya menggunakan Sphinx karena memang user guide tersebut dibuat dengan Sphinx.

Python

Sphinx tools yang membutuhkan python, jadi sebelum menginstall Sphinx syarat wajibnya adalah teman-teman sudah menginstall Python. Tidak masalah apakah itu Python 2.7.x atau Python 3.

Install Sphinx

Untuk melakukan instalasi Sphinx, caranya adalah sebagai berikut:
Python 2.7.x

$sudo apt install python-sphinx

Python 3

$sudo apt install python3-sphinx

Install sphinxcontrib-phpdomain

Untuk lebih jelasnya mengenai module ini teman-teman bisa cek disini. Lalu, untuk menginstallnya kita bisa menggunakan pip python.

pip install -U sphinxcontrib-phpdomain

Build Make HTML

Jika teman-teman sudah yakin proses sebelumnya sudah selesai, teman-teman bisa masuk ke directory user_guide nya dengan atau cd user_guide_src kemudian jalankan perintah make html untuk membuild file html.

$make html

Dengan demikian, akan menggenerate file html berdasarkan file source user guide yang telah ada. Teman-teman bisa mengecek directory build yang ada didalam directory user_guide_src yang semula tidak ada menjadi ada. Nah, disitu ada source html yang bisa kita gunakan untuk mempelajari user guide nya secara offline di komputer kita.