sphinx-autobuild
Rebuild Sphinx documentation on changes, with hot reloading in the browser.
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.11 or later; Sphinx must be installed (included as a dependency).
- 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 · maintenance · safety
permissive license (permissive) — 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.
last release 2025-08-25 (354 days) · last repo commit 2025-12-16 · 608 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 5,940,908 downloads/mo, #2,005 on PyPI
Alternatives
Verify before relying
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.- 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.
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 on this page. Verify before relying on it.
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
sphinx-autobuild on PyPI
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.
Requires Python 3.11 or later; Sphinx must be installed (included as a dependency).
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.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 | permissive license permissive |
| Python support | Supports the current Python release >=3.11 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 6 packagescoloramaSphinxstarletteuvicornwatchfileswebsockets |
| Maintenance | Aging 354 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 5,940,908 / month, #2,005 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleEnvironment :: Web EnvironmentFramework :: SphinxIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPyTopic :: DocumentationTopic :: Documentation :: SphinxTopic :: Software DevelopmentTopic :: Software Development :: DocumentationTopic :: Software Development :: Libraries :: Python ModulesTopic :: Utilities |
Evidence: sphinx_autobuild-2025.8.25-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx live reload”
- sphinx-autobuildWatches Sphinx documentation source files for changes and…
- readthedocs-sphinx-searchA Sphinx extension that adds real-time search-as-you-type…
- httpwatcherhttpwatcher is a simple HTTP server and library for serving static…
Give your agent the search over MCP, or paste the wish link into any chat.
More Software Development packages
Provides backported and experimental type hints for Python 3.9+, allowing use of newer typing features on older Python versions and enabling early experimentation with type system PEPs before they enter the standard library.
NumPy provides an N-dimensional array object and a comprehensive suite of mathematical, linear algebra, Fourier transform, and random number functions for scientific computing in Python.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Distlib provides low-level packaging utilities for building, distributing, and managing Python software—including metadata handling, version specifiers, wheel support, script installation, and dependency resolution.
See also livereload · jurigged · sphinx-press-theme · sphinx-bootstrap-theme · sphinxcontrib-devhelp · Flask-AutoIndex · sphinx-rtd-dark-mode · sphinxcontrib-htmlhelp · watchgod · sphinx-rtd-theme