summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2019-12-07 15:37:22 -0500
committerNed Batchelder <ned@nedbatchelder.com>2019-12-07 15:44:03 -0500
commitf21b73a9204750f271f1f8d042eb96f83292e5d3 (patch)
tree5c64c64fdb7fdcae470d365b1d19fbf447f23da6
parent04f823e202eac486a201ea6f01fd852259d375b3 (diff)
downloadpython-coveragepy-git-f21b73a9204750f271f1f8d042eb96f83292e5d3.tar.gz
sphinx-autobuild is handy
-rw-r--r--Makefile10
-rw-r--r--doc/requirements.pip1
2 files changed, 7 insertions, 4 deletions
diff --git a/Makefile b/Makefile
index 3556c038..3524d6fd 100644
--- a/Makefile
+++ b/Makefile
@@ -129,8 +129,10 @@ build_ext:
# Documentation
+DOCBIN = .tox/doc/bin
SPHINXOPTS = -aE
-SPHINXBUILD = .tox/doc/bin/sphinx-build $(SPHINXOPTS)
+SPHINXBUILD = $(DOCBIN)/sphinx-build $(SPHINXOPTS)
+SPHINXAUTOBUILD = $(DOCBIN)/sphinx-autobuild -p 9876 --ignore '.git/**' --open-browser
WEBHOME = ~/web/stellated/
WEBSAMPLE = $(WEBHOME)/files/sample_coverage_html
WEBSAMPLEBETA = $(WEBHOME)/files/sample_coverage_html_beta
@@ -139,11 +141,11 @@ docreqs:
tox -q -e doc --notest
dochtml: docreqs ## Build the docs HTML output.
- .tox/doc/bin/python doc/check_copied_from.py doc/*.rst
+ $(DOCBIN)/python doc/check_copied_from.py doc/*.rst
$(SPHINXBUILD) -b html doc doc/_build/html
-docopen: dochtml
- open doc/_build/html/index.html
+docdev: dochtml ## Build docs, and auto-watch for changes.
+ PATH=$(DOCBIN):$(PATH) $(SPHINXAUTOBUILD) -b html doc doc/_build/html
docspell: docreqs
$(SPHINXBUILD) -b spelling doc doc/_spell
diff --git a/doc/requirements.pip b/doc/requirements.pip
index bcc2840d..2722c9bd 100644
--- a/doc/requirements.pip
+++ b/doc/requirements.pip
@@ -8,3 +8,4 @@ sphinx==2.2.0
sphinx-rst-builder==0.0.1
sphinxcontrib-spelling==4.3.0
sphinx_rtd_theme==0.4.3
+sphinx-autobuild==0.7.1