From 0970edb3841c5f61b855da06d062523bb618738a Mon Sep 17 00:00:00 2001 From: Rick Altherr Date: Wed, 7 Feb 2018 14:27:02 -0800 Subject: [PATCH] docs: Make target for live reloading during editing Target starts sphinx-autobuild which watches the source files and rebuilds the output on writes. Output is served via a local HTTP server that injects code to refresh the page when a new version is available. Saving a source file triggers the browser to reload the page generated. Signed-off-by: Rick Altherr --- docs/Makefile | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index d8bf25c3..b52c6680 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,6 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build +SPHINXAUTOBUILD = sphinx-autobuild SPHINXPROJ = ProjectX-Ray SOURCEDIR = . BUILDDIR = _build @@ -12,9 +13,12 @@ BUILDDIR = _build help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: help Makefile +livehtml: + @$(SPHINXAUTOBUILD) -b html --ignore \*.swp --ignore \*~ $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" + +.PHONY: help livereload Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)