1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS    =
6SPHINXBUILD   = sphinx-build
7PAPER         = a4
8BUILDDIR      = sphinx_build
9
10# Internal variables.
11PAPEROPT_a4     = -D latex_paper_size=a4
12PAPEROPT_letter = -D latex_paper_size=letter
13ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14
15.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
16
17help:
18	@echo "Please use \`make <target>' where <target> is one of"
19	@echo "  html      to make standalone HTML files"
20	@echo "  dirhtml   to make HTML files named index.html in directories"
21	@echo "  pickle    to make pickle files"
22	@echo "  json      to make JSON files"
23	@echo "  pdf  	   to make PDF files and a HTML help project"
24	@echo "  changes   to make an overview of all changed/added/deprecated items"
25	@echo "  linkcheck to check all external links for integrity"
26	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
27
28clean:
29	-rm -rf $(BUILDDIR)/*
30
31pdf:
32	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
33	@echo
34	@echo "Build finished. The PDF pages are in $(BUILDDIR)/pdf."
35
36html:
37	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
38	@echo
39	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
40
41dirhtml:
42	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
43	@echo
44	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
45
46pickle:
47	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
48	@echo
49	@echo "Build finished; now you can process the pickle files."
50
51json:
52	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
53	@echo
54	@echo "Build finished; now you can process the JSON files."
55
56changes:
57	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
58	@echo
59	@echo "The overview file is in $(BUILDDIR)/changes."
60
61linkcheck:
62	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
63	@echo
64	@echo "Link check complete; look for any errors in the above output " \
65	      "or in $(BUILDDIR)/linkcheck/output.txt."
66