本文档托管在GitHub Pages
上,访问地址:
本项目文档采用mkdocs
生成,如需在本地预览查看,则需安装该工具。
$ pip install mkdocs
mkdocs
支持主题配置,本项目选择了第三方的mkdocs-material
。
$ pip install mkdocs-material
在项目根目录中运行如下命令:
$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 180211 22:48:35 server:283] Serving on http://127.0.0.1:8000
[I 180211 22:48:35 handlers:60] Start watching changes
[I 180211 22:48:35 handlers:62] Start detecting changes
然后在浏览器中访问http://127.0.0.1:8000
即可。