From f70226c8456cf577e4585d59d81ad731f88d8eff Mon Sep 17 00:00:00 2001 From: Daniel Chimeno Date: Sun, 19 Feb 2017 16:41:02 +0100 Subject: [PATCH] add way of autocompile documentation --- docs/Makefile | 5 +++++ docs/contributing/developing.rst | 10 ++++++++++ 2 files changed, 15 insertions(+) diff --git a/docs/Makefile b/docs/Makefile index 2333c272fe..62d14f607a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -180,3 +180,8 @@ pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +livehtml: + sphinx-autobuild --poll -p 4000 -H 0.0.0.0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + + diff --git a/docs/contributing/developing.rst b/docs/contributing/developing.rst index 9989ff3889..b48c501a48 100644 --- a/docs/contributing/developing.rst +++ b/docs/contributing/developing.rst @@ -180,3 +180,13 @@ To clear the built HTML and start fresh, so you can see all warnings thrown when $ cd docs/ $ make clean $ make html + +Wagtail also provides a way for documentation to be compiled automatically on each change. +To do this, you can run the following command to see the changes automatically at ``localhost:4000``: + +.. code-block:: console + + $ cd docs/ + $ make livehtml + +