Metadata-Version: 2.0
Name: sphinx-autobuild
Version: 0.2.0
Summary: Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server.
Home-page: https://github.com/GaretJax/sphinx-autobuild
Author: Jonathan Stoppani
Author-email: jonathan@stoppani.name
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: watchdog (==0.6.0)
Requires-Dist: argh (==0.23.3)
Requires-Dist: pathtools (==0.1.2)
Requires-Dist: PyYAML (==3.10)
Requires-Dist: tornado (==3.1.1)
Requires-Dist: livereload (==2.0.0)

sphinx-autobuild
================

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.


