---
id: sphinx-autobuild
version: "2025.8.25"
license: unclear
license_treatment: permissive
maintenance: aging
---

# sphinx-autobuild — Rebuild Sphinx documentation on changes, with hot reloading in the browser.

License: permissive · Maintenance: aging · Downloads: 5.9M/mo

## What it is and what it does

sphinx-autobuild is a development tool that wraps Sphinx's build process with file watching and browser auto-reload. When you run it, it starts a local web server, watches your documentation source directory for changes, and automatically rebuilds the docs whenever files change—then pushes a reload signal to any open browser windows showing the docs, so you see updates instantly without manual refresh.

It runs on top of Sphinx, starlette, uvicorn, and watchfiles, so it's a thin layer that adds live-reload capability to your normal Sphinx workflow. You point it at your source and output directories (the same way you'd call sphinx-build), and it accepts all the same arguments plus a few extras like --port, --host, --open-browser, and --watch to monitor additional directories. It's designed for documentation writers and theme developers who want to iterate quickly without switching between editor and browser.

Use it for:

- Iterating on Sphinx documentation content: edit .rst files and see changes reflected in the browser instantly.
- Developing or customizing a Sphinx HTML theme: watch the theme directory alongside docs to verify layout changes in real time.
- Working on multiple Sphinx projects simultaneously: use --port=0 to auto-assign ports and avoid manual port management.
- Building documentation as part of a local development loop: integrate with Makefile or CI-like workflows using --pre-build and --post-build hooks.
- Debugging documentation build issues: enable SPHINX_AUTOBUILD_DEBUG to see which files trigger rebuilds and which ignore patterns are active.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Watches Sphinx documentation source files for changes and automatically rebuilds the docs, then reloads open browser windows to show the updated output.

Yes, if you regularly write or maintain Sphinx documentation. It eliminates the friction of manual rebuilds and browser refreshes, making the edit-preview cycle much faster. The low install friction and permissive license make it a low-risk addition to any Sphinx workflow. The aging maintenance status is not a blocker—the tool is stable and the repository is still active—but monitor it if you depend on frequent updates for new Sphinx features.

## Install

pip install sphinx-autobuild
uv add sphinx-autobuild
poetry add sphinx-autobuild

## Installing sphinx-autobuild

Before you install: Low friction: pure Python wheel with six runtime dependencies (Sphinx, starlette, uvicorn, watchfiles, websockets, colorama). Maintenance status is aging—last release was 354 days ago—but the repository is active and not archived, with a recent commit on 2025-12-16.

License in practice: MIT license (permissive) means you can use, modify, and distribute this package freely with minimal restrictions, making it safe for both open-source and commercial projects.

Quickstart:

pip install sphinx-autobuild

sphinx-autobuild docs docs/_build/html

This starts a server at http://127.0.0.1:8000 and watches the docs/ directory for changes.

Requires Python 3.11 or later; Sphinx must be installed (included as a dependency).

Verify before relying:

- Whether the aging maintenance status (354 days since last release) affects stability for active Sphinx projects.
- Performance characteristics when watching large documentation trees with many files.

## Package facts

- License: not declared (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: aging
- Downloads: 5.9M/month (top 5,000 on PyPI)
- Known vulnerabilities: none known

## Tags

sphinx live reload, sphinx documentation auto rebuild, sphinx hot reloading, sphinx watch and rebuild, sphinx development server, sphinx live preview, sphinx autobuild, sphinx-plugin, live-reload, dev-tool

[View on SkillFed](https://skillfed.io/packages/sphinx-autobuild) · [View on PyPI](https://pypi.org/project/sphinx-autobuild/)