Skip to main content

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

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.0 - 2013/12/25

  • Explicitly parse sphinx-build arguments for better compatibility.

0.1.0 - 2013/12/25

  • Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-autobuild-0.2.0.tar.gz (10.2 kB view hashes)

Uploaded Source

Built Distribution

sphinx_autobuild-0.2.0-py27-none-any.whl (6.1 kB view hashes)

Uploaded Python 2.7

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page