Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server.
Project description
Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server.
Installation
You can use pip to install the package along with its requirements:
pip install sphinx-autobuild
Usage
The package installs a single executable script, named sphinx-autobuild. The script takes the same arguments as the sphinx-build command installed by Sphinx plus a -p/--port option to specify the port on which the documentation shall be served (default 8000).
To build a classical Sphinx documentation set, issue the following command:
sphinx-autobuild docs docs/_build/html
And then visit the webpage served at http://127.0.0.1:8000. Each time a change to the documentation source is detected, the HTML is rebuilt and the browser automatically reloaded.
To stop the server simply press ^C.
Makefile integration
To integrate the sphinx-autobuild command in the Makefile generated by Sphinx, add the following target:
livehtml:
sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
Then run with:
make livehtml
0.2.3 - 2013/12/25
Ignore the paths indicated by the -w and -d arguments when watching for changes to the documentation.
0.2.1 - 2013/12/25
Catch subprocess PTY reading errors.
0.2.0 - 2013/12/25
Explicitly parse sphinx-build arguments for better compatibility.
0.1.0 - 2013/12/25
Initial release.
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
Hashes for sphinx_autobuild-0.3.0-py27-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5e29ceb2f64a63e1ce301af4c74beb27b5a661e5863d00454f59940ba24d739d |
|
| MD5 | cc4c55677d8c792ad8875b2977887633 |
|
| BLAKE2b-256 | 1976ce18442a7e8b8ed5034be6303bd7c5831d1753cef220158d0ea61868f6cd |
