CodeIgniter 的用户指南使用 Sphinx 软件进行管理，并可以生成各种不同的格式。所有页面都采用 ReStructured Text 格式书写，这种格式非常方便人们阅读。
Sphinx 需要 Python 3.5+ 版本，如果你正在运行 macOS 或 Linux，则可能已经安装了它。
你可以在终端窗口中执行 python 或 python3 来确认。
python --version
Python 2.7.17
python3 --version
Python 3.6.9
# 对于使用 Python 启动器的 Windows
py -3 --version
Python 3.8.1如果你的版本低于 3.5+，请从 Python.org 安装最新的 3.x 版本。Linux 用户应该使用操作系统自带的包管理器来更新。
现在你已经安装并运行了 Python 3.x，我们将安装 pip (Python 包安装程序)。
你可以使用 pip 或 pip3 检查是否已安装 pip。如你所见，pip 遵循与 Python 相同的命名约定。请注意，输出的末尾应该显示 python 3.x。
pip --version
pip 9.0.1 from /usr/lib/python2.7/dist-packages (python 2.7)
pip3 --version
pip 9.0.1 from /usr/lib/python3/dist-packages (python 3.6)
# 对于使用 Python 启动器的 Windows
py -3 -m pip --version
pip 20.0.2 from C:\Users\<username>\AppData\Local\Programs\Python\Python38\lib\site-packages\pip (python 3.8)使用 Linux 包管理器安装 pip/setuptools/wheel
如果你使用从 Python.org 下载的 Python 3.5+，则 pip 已经安装好了。
现在我们需要安装 Sphinx 和它的依赖项。根据操作系统选择 pip 或 pip3。
此步骤之后，你需要重启终端窗口，否则 Python 将找不到我们刚刚安装的所有应用程序。
pip install -r requirements.txt
pip3 install -r requirements.txt
# 对于使用 Python 启动器的 Windows
py -3 -m pip install -r requirements.txt是时候总结一下并生成文档了。
make html如果你喜欢使用 Docker 构建文档的话，可以这样：
- clone 代码库到本地，例如
/my/ci4目录 - 在
/my/ci4目录下执行docker build -t ci4 . - 在
/my/ci4目录下执行docker run -t --rm -v /my/ci4:/ci ci4
执行完毕后，/my/ci4/build/html 目录就是生成的文档啦。
所有的源文件都在 source/ 目录下，在这里你可以添加新的文档或修改已有的文档。
很显然，HTML 文档才是我们最关心的，因为这毕竟才是用户最终看到的。 由于对自动生成的文件进行版本控制没有意义，所以它们并不在版本控制之下。 你如果想要预览 HTML 文档，你可以重新生成它们。生成 HTML 文档非常简单， 首先进入你的用户指南目录，然后执行上面安装步骤中的最后一步:
make html
你将会看到正在编译中的信息，编译成功后，生成的用户指南和图片都位于 build/html/ 目录下。在 HTML 第一次编译之后，后面将只会针对修改的文件进行重编译，这将大大的节约我们的时间。 如果你想再重新全部编译一次，只需删除 build 目录然后编译即可。
感谢这些可爱的童鞋为中文手册做出的卓越贡献。 (emoji key):
本项目遵循 all-contributors 规范。欢迎任何形式的贡献！