summaryrefslogtreecommitdiff
path: root/docs/Makefile
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2014-12-08 01:34:03 +0200
committerTim Graham <timograham@gmail.com>2014-12-08 07:23:34 -0500
commitb327a614eb7d885441c6a2575e10b70ac1352aae (patch)
tree460d53b067eba6b424b12e309dac47a35a8d1175 /docs/Makefile
parent6bc343d8749b3698dd15d1de59dfc02928bb772c (diff)
Added an "htmlview" target to open docs after building them.
This is helpful if you build and test documentation updates in your development env. Copied from CPython's Doc/Makefile.
Diffstat (limited to 'docs/Makefile')
-rw-r--r--docs/Makefile7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/Makefile b/docs/Makefile
index f2502be3a7..f57db99699 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -2,6 +2,7 @@
#
# You can set these variables from the command line.
+PYTHON ?= python
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
PAPER ?=
@@ -15,11 +16,12 @@ ALLSPHINXOPTS = -n -d $(BUILDDIR)/doctrees -D language=$(LANGUAGE) $(PAPEROPT_
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.PHONY: help clean html htmlview dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
+ @echo " htmlview to open the index page built by the html target in your browser"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@@ -48,6 +50,9 @@ html:
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+htmlview: html
+ $(PYTHON) -c "import webbrowser; webbrowser.open('_build/html/index.html')"
+
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo