1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS    =
6SPHINXBUILD   = sphinx-build
7PAPER         =
8
9# Internal variables.
10PAPEROPT_a4     = -D latex_paper_size=a4
11PAPEROPT_letter = -D latex_paper_size=letter
12ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13
14.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
15
16help:
17	@echo "Please use \`make <target>' where <target> is one of"
18	@echo "  html      to make standalone HTML files"
19	@echo "  dirhtml   to make HTML files named index.html in directories"
20	@echo "  pickle    to make pickle files"
21	@echo "  json      to make JSON files"
22	@echo "  htmlhelp  to make HTML files and a HTML help project"
23	@echo "  qthelp    to make HTML files and a qthelp project"
24	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
25	@echo "  changes   to make an overview of all changed/added/deprecated items"
26	@echo "  linkcheck to check all external links for integrity"
27	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
28
29clean:
30	-rm -rf _build/*
31
32html:
33	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
34	@echo
35	@echo "Build finished. The HTML pages are in _build/html."
36
37dirhtml:
38	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
39	@echo
40	@echo "Build finished. The HTML pages are in _build/dirhtml."
41
42pickle:
43	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
44	@echo
45	@echo "Build finished; now you can process the pickle files."
46
47json:
48	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
49	@echo
50	@echo "Build finished; now you can process the JSON files."
51
52htmlhelp:
53	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
54	@echo
55	@echo "Build finished; now you can run HTML Help Workshop with the" \
56	      ".hhp project file in _build/htmlhelp."
57
58qthelp:
59	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
60	@echo
61	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
62	      ".qhcp project file in _build/qthelp, like this:"
63	@echo "# qcollectiongenerator _build/qthelp/futures.qhcp"
64	@echo "To view the help file:"
65	@echo "# assistant -collectionFile _build/qthelp/futures.qhc"
66
67latex:
68	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
69	@echo
70	@echo "Build finished; the LaTeX files are in _build/latex."
71	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
72	      "run these through (pdf)latex."
73
74changes:
75	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
76	@echo
77	@echo "The overview file is in _build/changes."
78
79linkcheck:
80	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
81	@echo
82	@echo "Link check complete; look for any errors in the above output " \
83	      "or in _build/linkcheck/output.txt."
84
85doctest:
86	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
87	@echo "Testing of doctests in the sources finished, look at the " \
88	      "results in _build/doctest/output.txt."
89