« Previous | Next » 

Revision 63733717

ID637337172c447c4335271639b2bffb51ab01af06
Parent a4fd5b13
Child 47d073aa

Added by Jacob Floyd over 6 years ago

[TASK] Add support for sphinx-autobuild in docs

This adds support for sphinx-autobuild, which watches the Documentation
directory and automatically re-renders docs when changed. This allows
for a livepreview while editing the docs. It also serves the pages via
the python-livereload server so they will be automatically refreshed
when the docs are re-rendered.

To use it, install `sphinx-autobuild`_::

pip install sphinx-autobuild

To use livepreview just run ``make livehtml`` instead of ``make html``.
Then, visit http://127.0.0.1:8000 to see the livereload version of the
docs.

``make livehtml`` renders the docs exactly the same as ``make html``
does. A ``livereload.js`` script does get injected, but not by the
rendering process. The script gets injected on the fly by
python-livereload when serving the pages.

.. _sphinx_autobuild: https://github.com/GaretJax/sphinx-autobuild

Change-Id: I8f321c82342ae228577824051f19fb1e22496681
Releases: master, 3.0, 2.3, 2.2, 2.1, 2.0, 1.1

  • added
  • modified
  • copied
  • renamed
  • deleted