Watch a Sphinx directory and rebuild the documentation when a change is detected
Rebuild Sphinx documentation on changes, with live-reload in the browser.
Installation
sphinx-autobuild is available on PyPI. It can be installed using pip:
pip install sphinx-autobuild
Usage
To build a classical Sphinx documentation set, run:
sphinx-autobuild docs docs/_build/html
This will start a server at http://127.0.0.1:8000 and start watching for changes in the docs/ directory. When a change is detected in docs/, the documentation is rebuilt and any open browser windows are reloaded automatically. KeyboardInterrupt (ctrl+c) will stop the server.
Command line options
sphinx-autobuild accepts the same arguments as sphinx-build (these get passed to sphinx-build on each build). It also has a