sphinx-doc/sphinx-autobuild

这是什么？

核心功能

• 01源目录文件变化时自动重新构建 Sphinx 文档。
• 02构建完成后自动刷新已打开的浏览器页面。
• 03兼容 sphinx-build 的全部参数，并提供服务器与监视相关选项。
• 04支持用 glob 或正则表达式忽略被监视的文件。
• 05可在每次构建前后执行自定义命令。
• 06可自动选择空闲端口，并在启动时打开浏览器。

适用场景

• 编写项目文档时即时预览修改效果。
• 开发自定义 Sphinx HTML 主题，同时监视主题文件变化。
• 同时运行多个文档项目，各自使用独立端口和输出目录。
• 通过构建前后钩子发送构建开始和结束的通知。

快速上手

1. 1

   使用 pip 从 PyPI 安装 sphinx-autobuild

   pip install sphinx-autobuild
2. 2

   启动服务器并监视文档目录的变化

   sphinx-autobuild docs docs/_build/html

使用前须知

• !需要已有的 Sphinx 文档项目才能发挥作用。

收录于专题

标签

常见问题

sphinx-autobuild 是什么？

一个命令行工具，监视 Sphinx 文档目录，文件变化时自动重建文档并通过本地服务器热重载浏览器。 sphinx-autobuild 监视 Sphinx 文档源目录，文件一有变化就调用 sphinx-build 重新构建。生成的 HTML 通过本地 Web 服务器提供，默认地址为 http://127.0.0.1:8000，打开的浏览器页面会在每次重建后自动刷新，写文档时无需手动构建或刷新。

sphinx-autobuild 可以免费使用吗？用的什么许可证？

sphinx-autobuild 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。

sphinx-autobuild 还在维护吗？

活跃维护中。sphinx-autobuild 最近一次提交是在 2026年10月23日。

sphinx-autobuild 适合用来做什么？

编写项目文档时即时预览修改效果。 开发自定义 Sphinx HTML 主题，同时监视主题文件变化。 同时运行多个文档项目，各自使用独立端口和输出目录。 通过构建前后钩子发送构建开始和结束的通知。

sphinx-autobuild 怎么安装和运行？

使用 pip 从 PyPI 安装 sphinx-autobuild: pip install sphinx-autobuild 启动服务器并监视文档目录的变化: sphinx-autobuild docs docs/_build/html

在哪里获取 sphinx-autobuild？

源代码和安装说明在 GitHub 上：https://github.com/sphinx-doc/sphinx-autobuild