.. toctree:: :hidden: :maxdepth: 4
- 参考 这里 安装 Sphinx。
pip install sphinx_rtd_theme安装 Read The Docs 主题。pip install jieba安装中文分词。pip install sphinx-comments安装 Sphinx 讨论区插件。- :doc:`/rest-example` 是 ReST 的一些基本语法，也可以参考已完成的文档。
- 修改之后，在项目根目录下
make clean && make html即可在build/html/index.html查看本地构建的主页。请注意在修改章节目录结构之后需要make clean一下，不然可能无法正常更新。 - 确认修改无误之后，将
main主分支上的修改 merge 到deploy分支，在项目根目录下make deploy即可将更新后的文档部署到用于部署的deploy分支上。 如果与其他人的提交冲突的话，请删除掉docs目录再进行 merge。
补充：
支持实时显示修改rst文件后的html文档的方法：
pip install autoload安装 Sphinx 自动加载插件。- 在项目根目录下
sphinx-autobuild source build/html即可在浏览器中访问 http://127.0.0.1:8000/ 查看本地构建的主页。