修改和构建本项目¶
参考 这里 安装 Sphinx。
pip install sphinx_rtd_theme
安装 Read The Docs 主题。pip install jieba
安装中文分词。pip install sphinx-comments
安装 Sphinx 讨论区插件。reStructuredText 基本语法 是 ReST 的一些基本语法,也可以参考已完成的文档。
修改之后,在项目根目录下
make clean && make html
即可在build/html/index.html
查看本地构建的主页。请注意在修改 章节目录结构之后需要make clean
一下,不然可能无法正常更新。确认修改无误之后,在项目根目录下
make deploy
然后即可git add -A && git commit -m && git push
上传到远程仓库。 如果出现冲突的话,请删除掉docs
目录再进行 merge。