修改和构建本项目#

  1. 参考 这里 安装 Sphinx。

  2. pip install sphinx_rtd_theme 安装 Read The Docs 主题。

  3. pip install jieba 安装中文分词。

  4. pip install sphinx-comments 安装 Sphinx 讨论区插件。

  5. reStructuredText 基本语法 是 ReST 的一些基本语法,也可以参考已完成的文档。

  6. 修改之后,在项目根目录下 make clean && make html 即可在 build/html/index.html 查看本地构建的主页。请注意在修改章节目录结构之后需要 make clean 一下,不然可能无法正常更新。

  7. 如想对项目做贡献的话,直接提交 pull request 即可。

补充:

支持实时显示修改rst文件后的html文档的方法:

  1. pip install autoload 安装 Sphinx 自动加载插件。

  2. 在项目根目录下 sphinx-autobuild source  build/html 即可在浏览器中访问 http://127.0.0.1:8000/ 查看本地构建的主页。