# Makefile for Sphinx documentation
#

# You can set these variables from the command line.

SPHINXOPTS	=
SPHINXBUILD	= sphinx-build
PAPER		=
BUILDDIR	= build

# Internal variables.
PAPEROPT_a4		= -D latex_paper_size=a4 
PAPEROPT_letter	= -D latex_paper_size-letter 
ALLSPHINXOPTS	= -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source

.PHONY: help clean html dirhtml singlehtml pickle json htmhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest

help:
		@echo "Please use \`make <target>' where <target> is one of"
		@echo "	html		to make standalone HTML files"
		@echo "	dirhtml		to make HTML files named index.html in directories"
		@echo "	singlehtml	to make a single large HTML file"
		@echo "	pickle		to make "
		@echo "	json		to make "
		@echo "	htmlhelp	to make "
		@echo "	qthelp		to make "
		@echo "	devhelp		to make "
		@echo "	epub		to make "
		@echo "	latex		to make "
		@echo "	latexpdf	to make "
		@echo "	text		to make "
		@echo "	man			to make "
		@echo "	changes		to make "
		@echo "	linkcheck	to make "
		@echo "	doctest		to make "

clean:
		-rm	-rf	$(BUILDDIR)/*

html:
		$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
		@echo
		@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."


dirhtml:
		$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
		@echo
		@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
		
singlehtml:
		$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
		@echo
		@echo "Build finished. The HTML pages are in $(BUILDDIR)/singlehtml."

pickle:
		$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
		@echo
		@echo "Build finished. Now you can process pickle files."

json:
		$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
		@echo
		@echo "Build finished. Now you can process json files."

htmlhelp:
		$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
		@echo
		@echo ".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:
		$(SPHINXBUILD) -b qthtml $(ALLSPHINXOPTS) $(BUILDDIR)/qthtml
		@echo
		@echo "Build finished; now you can run "qcollectiongenerator" with the" \
			  ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
		@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/makeapp.qhcp"
		@echo "To view the help file:"
		@echo "# assistent -collectionFile $(BUILDDIR)/qthelp/makeapp.qhc"

devhelp:
		$(SPHINXBUILD) -b qthtml $(ALLSPHINXOPTS) $(BUILDDIR)/qthtml
		@echo
		@echo "Build finished; now you can run "qcollectiongenerator" with the" \
			  ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
		@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/makeapp.qhcp"
		@echo "To view the help file:"
		@echo "# assistent -collectionFile $(BUILDDIR)/qthelp/makeapp.qhc"

epub:
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
	@echo
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	@echo
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
	      "(use \`make latexpdf' here to do that automatically)."

latexpdf:
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	@echo "Running LaTeX files through pdflatex..."
	make -C $(BUILDDIR)/latex all-pdf
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
	@echo
	@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
	@echo
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

changes:
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
	@echo
	@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
	@echo
	@echo "Link check complete; look for any errors in the above output " \
	      "or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
	@echo "Testing of doctests in the sources finished, look at the " \
	      "results in $(BUILDDIR)/doctest/output.txt."
