实时预览sphinx文档
sphinx-reload的Python项目详细描述
安装
要安装,请使用pip(或easy_install):
$ pip install sphinx-reload
该包安装命令行程序sphinx-reload:
$ sphinx-reload --version v0.2.0
开始
要开始实时预览文档,只需通过 文档的根作为命令行参数,使用sphinx-reload。 下面是一个假设文档根目录位于当前 目录并命名为docs:
$ sphinx-reload docs/
sphinx-reload将在您喜爱的浏览器的新选项卡中打开预览 并注意文档源中的更改 文件(例如,文档下的任何reStructuredText文件 根)。
要查看进一步的使用详细信息,请使用脚本的--help选项:
$ sphinx-reload --help