本项目文档采用 mkdocs
生成,如需在本地预览查看,则需安装该工具。
推荐使用 Python 虚拟环境。
$ python3 -m venv .venv
$ source .venv/bin/activate
install mkdocs
and material design
$ pip install mkdocs-material
在项目根目录中运行如下命令:
$ cd v3x
$ 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
即可。