实时预览sphinx文档

sphinx-reload的Python项目详细描述


PyPI VersionBuild Status

demo.gif

安装

要安装,请使用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

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java接口中的每个方法都是抽象的,但在抽象类中,我们也只能使用抽象方法   初始化Java中声明的、未初始化的变量会发生什么情况?   java BouncyCastle openPGP将字节[]数组加密为csv文件   在Java中将类A(和所有子类)映射到类B的实例的字典   RSA公钥编码,在Java和Android中,代码相同,结果不同   java在安卓中实现数字检测语音识别   java取消选择复选框   java如何在其他配置中重用Maven配置XML片段   java有没有一种有效的方法来检查HashMap是否包含映射到相同值的键?   spring处理程序调度失败;嵌套的例外是java。lang.NoClassDefFoundError:org/apache/http/client/HttpClient   带有ehcache的java多层缓存   java如何访问chromium(或任何其他浏览器)cookie   java通过将两个集合与spring data mongodb data中的条件合并来获取计数   安卓中R.java的语法错误