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