{"categories":[{"label":"Software Development","url":"https://skillfed.io/packages/category/software-development/3"},{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/4"},{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/2"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Watches Sphinx documentation source files for changes and automatically rebuilds the docs, then reloads open browser windows to show the updated output.","skillfed_tags":["sphinx-plugin","live-reload","dev-tool"],"use_cases":["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."],"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\u2014then pushes a reload signal to any open browser windows showing the docs, so you see updates instantly without manual refresh.\n\nIt 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.","worth_installing":"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\u2014the tool is stable and the repository is still active\u2014but monitor it if you depend on frequent updates for new Sphinx features."},"id":"sphinx-autobuild","links":{"html":"https://skillfed.io/packages/sphinx-autobuild","md":"https://skillfed.io/packages/sphinx-autobuild.md","pypi":"https://pypi.org/project/sphinx-autobuild/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2025-08-25","license_spdx":null,"license_treatment":"permissive","name":"sphinx-autobuild","python_support":"supports_current","summary":"Rebuild Sphinx documentation on changes, with hot reloading in the browser."},"popularity":{"monthly_downloads":5940908,"position":2005,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"2025.8.25"}