Rebuild Sphinx documentation on changes, with hot reloading in the browser.
Verified details
These details have been verified by PyPIProject links
Owner
GitHub Statistics
Maintainers
Project description
Rebuild Sphinx documentation on changes, with hot reloading in the browser.
Installation
sphinx-autobuild is available on PyPI. It can be installed using pip:
pip install sphinx-autobuildUsage
To build a classical Sphinx documentation set, run:
sphinx-autobuild docs docs/_build/htmlThis 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 few additional options, which can seen by running sphinx-autobuild --help:
$ sphinx-autobuild --help
usage: sphinx-autobuild [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...]
...
autobuild options:
--port PORT port to serve documentation on. 0 means find and use a free port
--host HOST hostname to serve documentation on
--re-ignore RE_IGNORE
regular expression for files to ignore, when watching for changes
--ignore IGNORE glob expression for files to ignore, when watching for changes
--no-initial skip the initial build
--open-browser open the browser after building documentation
--delay DELAY how long to wait before opening the browser
--watch DIR additional directories to watch
--pre-build COMMAND additional command(s) to run prior to building the documentationUsing with Makefile
FYI: Sphinx is planning to move away from using Makefile.
To use sphinx-autobuild with the Makefile generated by Sphinx, add the following to the end of the Makefile:
livehtml:
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)make livehtml will now invoke sphinx-autobuild.
If you generated the Makefile with an older version of sphinx, this syntax might not work for you. Consider updating to the newer structure.
Automatically opening the browser
sphinx-autobuild can open the homepage of the generated documentation in your default browser. Passing --open-browser will enable this behaviour.
Automatically selecting a port
sphinx-autobuild asks the operating system for a free port number and use that for its server. Passing --port=0 will enable this behaviour.
Workflow suggestions
Working on a Sphinx HTML theme
When working on a Sphinx HTML theme, add the source directory of the theme as a watch directory. It is also recommended to disable Sphinx’s incremental builds by passing the -a option to sphinx-autobuild.
sphinx-autobuild -a docs docs/_build/html --watch path/to/themeThis results in slower builds, but it ensures that all pages are built from the same state of the HTML theme. It also works around a known issue in Sphinx which causes significant problems during theme development.
Working on multiple projects
When working on multiple Sphinx documentation projects simultaneously, it is required to use different output directories for each project. It is also recommended to use --port=0 and --open-browser to avoid needing to manually manage ports and opening browser windows (which can get tedious quickly).
sphinx-autobuild --port=0 --open-browser pikachu/docs pikachu/docs/_build/html &
sphinx-autobuild --port=0 --open-browser magikarp/docs magickarp/docs/_build/html &Relevant Sphinx Bugs
Sphinx does not detect changes in non-document, non-code files in incremental mode, like theme files and static files.
At the time of writing, the only known workaround is to instruct Sphinx to rebuild the relevant pages. This can be done by disabling incremental mode (with -a) or passing relevant filenames in addition to source and output directory in the CLI.
Acknowledgements
This project stands on the shoulders of giants, without whom this project would not be possible.
Many thanks to everyone who has contributed code as well as participated in discussions on the issue tracker. This project is better thanks to your contribution.
Project details
Verified details
These details have been verified by PyPIProject links
Owner
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx_autobuild-2024.10.3.tar.gz.
File metadata
- Download URL: sphinx_autobuild-2024.10.3.tar.gz
- Upload date:
- Size: 14.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 248150f8f333e825107b6d4b86113ab28fa51750e5f9ae63b59dc339be951fb1 |
|
| MD5 | f2e25fcd546f9135f7104bb0d269ea83 |
|
| BLAKE2b-256 | a52c155e1de2c1ba96a72e5dba152c509a8b41e047ee5c2def9e9f0d812f8be7 |
File details
Details for the file sphinx_autobuild-2024.10.3-py3-none-any.whl.
File metadata
- Download URL: sphinx_autobuild-2024.10.3-py3-none-any.whl
- Upload date:
- Size: 11.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 158e16c36f9d633e613c9aaf81c19b0fc458ca78b112533b20dafcda430d60fa |
|
| MD5 | 502227db5aa60ca942a2b84bc32ac5c1 |
|
| BLAKE2b-256 | 18c0eba125db38c84d3c74717008fd3cb5000b68cd7e2cbafd1349c6a38c3d3b |
