查看sphinx目录并在检测到更改时重新生成文档。还包括一个支持livereload的web服务器。
sphinx-autobuild的Python项目详细描述
斯芬克斯自动建筑
查看sphinx目录并在更改为 检测。还包括支持LivereLoad的Web服务器。
安装
您可以使用pip安装软件包及其要求：
pip install sphinx-autobuild
用法
该包安装一个可执行脚本，名为sphinx autobuild。 脚本采用与安装的sphinx build命令相同的参数 斯芬克斯加上以下选项：
- -p / --端口 选项，指定文档应在哪个端口上 提供（默认8000）
- -h / --主机 选项，用于指定文档应在其上运行的主机 提供（默认127.0.0.1）
- -i / --ignore 允许多个选项，指定file ignore glob 观察更改时的表达式，例如： *.tmp
- -b / --打开浏览器 本文档
- --无初始 禁用初始生成
- 在打开浏览器之前，如果 --选择了打开浏览器（默认为5）
- -z / --允许多个，指定其他目录的选项 要观看，例如： some/extra/dir
- --轮询 强制轮询，对于不支持 在共享文件夹中触发文件更新
要构建经典的sphinx文档集，请发出以下命令：
sphinx-autobuild docs docs/_build/html
然后访问
要停止服务器，只需按 ^c
生成文件集成
要将sphinx autobuild命令集成到sphinx生成的makefile中， 添加以下目标：
livehtml:
sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
然后使用：
make livehtml
自动启动浏览器
如果一次处理多个sphinx文档存储库（例如 处理具有交叉引用intersphinx链接的相关文档， 管理多个浏览器窗口并手动选择端口号 困难而乏味。通过在命令行上选择 --端口 0 ， sphinx autobuild将使用端口for生成一个随机的高编号 当前未使用的端口。
要进一步简化使用寿命，请使用 -b （ --打开浏览器 ）选项 触发Livereload自动打开浏览器的功能 窗口。使用 -s （ --延迟）将秒数更改为 在启动浏览器之前延迟，您可能需要执行某些操作 如下所示，以确保删除所有缓存的内容 在sphinx autobuild开始监视文件以完全呈现 正确记录：
# Clean out any cached content before starting.
make clean 2>/dev/null
# Background a trigger for initial build of all files.
(sleep 1 && touch source/*.rst) &
sphinx-autobuild -q \
-p 0 \
--open-browser \
--delay 5 \
--ignore "*.swp" \
--ignore "*.pdf" \
--ignore "*.log" \
--ignore "*.out" \
--ignore "*.toc" \
--ignore "*.aux" \
--ignore "*.idx" \
--ignore "*.ind" \
--ignore "*.ilg" \
--ignore "*.tex" \
source \
build/html
欢迎加入QQ群-->： 979659372
