实时预览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对ServiceListener和ServiceTracker调用提供了哪些排序保证?   java找不到方法格式的符号(DateTimeFormatter)?   mysql有没有一种方法可以将TCPDump输出到一个文件中,并用Java对其进行过滤,每5秒钟用新数据覆盖一次该文件?   java如何最好地配置用户上传支持文件的上传位置   java我在Android上使用OData4j,我无法获取实体   JPA实体关系简单示例中的java获取错误   JAVANoClassDefFoundError:安卓。应用程序。用法安卓中的UsageStatsManager   Eclipse中javaoo代码分析   java MethodVisitor抛出类格式错误   java为什么在从ViewModel调用时,改型排队不起作用?   调试小程序Java控制台:删除跟踪消息大小限制   java复杂安卓活动动画   java如何在使用JDOM2解析XML时忽略注释内容   java通过循环创建文本字段   即使在bufferedwriter关闭后也未发现java文件异常   单链表恢复中的java错误