skip to navigation
skip to content

Not Logged In

sphinx-autobuild 0.2.3

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server.

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server.

Installation

sphinx-autobuild relies on a not-yet-released version of python-livereload. You can install it through pip by issuing the following command:

pip install https://github.com/lepture/python-livereload/archive/master.zip

You can then use pip to install the package:

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

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.
 
File Type Py Version Uploaded on Size
sphinx-autobuild-0.2.3.tar.gz (md5) Source 2013-12-25 10KB
sphinx_autobuild-0.2.3-py27-none-any.whl (md5) Python Wheel 2.7 2013-12-25 6KB
  • Downloads (All Versions):
  • 15 downloads in the last day
  • 167 downloads in the last week
  • 930 downloads in the last month