heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added an "htmlview" target to open docs after building them.

Browse Source 
This is helpful if you build and test documentation updates in
your development env.

Copied from CPython's and Django's Doc/Makefile.
This commit is contained in:
Berker Peksag 2015-01-09 23:05:04 +02:00
parent b63b564e2e
commit c87825b692
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/Makefile
View File

@ -2,6 +2,7 @@
#
# You can set these variables from the command line.
PYTHON ?= python
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
@ -14,11 +15,12 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.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"
@ -46,6 +48,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