1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS    = -T
6SPHINXBUILD   = sphinx-build
7PAPER         =
8BUILDDIR      = output
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 singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest dist-html site-mako
16
17help:
18	@echo "Please use \`make <target>' where <target> is one of"
19	@echo "  html       to make standalone HTML files"
20	@echo "  dist-html  same as html, but places files in /doc"
21	@echo "  dirhtml    to make HTML files named index.html in directories"
22	@echo "  singlehtml to make a single large HTML file"
23	@echo "  pickle     to make pickle files"
24	@echo "  json       to make JSON files"
25	@echo "  htmlhelp   to make HTML files and a HTML help project"
26	@echo "  qthelp     to make HTML files and a qthelp project"
27	@echo "  devhelp    to make HTML files and a Devhelp project"
28	@echo "  epub       to make an epub"
29	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
30	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
31	@echo "  text       to make text files"
32	@echo "  man        to make manual pages"
33	@echo "  changes    to make an overview of all changed/added/deprecated items"
34	@echo "  linkcheck  to check all external links for integrity"
35	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
36
37clean:
38	-rm -rf $(BUILDDIR)/*
39
40html:
41	$(SPHINXBUILD) -b html -A mako_layout=html $(ALLSPHINXOPTS) $(BUILDDIR)/html
42	@echo
43	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
44
45dist-html:
46	$(SPHINXBUILD) -b html -A mako_layout=html $(ALLSPHINXOPTS) ..
47	@echo
48	@echo "Build finished.  The HTML pages are in ../."
49
50dirhtml:
51	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
52	@echo
53	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
54
55singlehtml:
56	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
57	@echo
58	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
59
60pickle:
61	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
62	@echo
63	@echo "Build finished; now you can process the pickle files."
64
65json:
66	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
67	@echo
68	@echo "Build finished; now you can process the JSON files."
69
70htmlhelp:
71	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
72	@echo
73	@echo "Build finished; now you can run HTML Help Workshop with the" \
74	      ".hhp project file in $(BUILDDIR)/htmlhelp."
75
76qthelp:
77	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
78	@echo
79	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
80	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
81	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SQLAlchemy.qhcp"
82	@echo "To view the help file:"
83	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SQLAlchemy.qhc"
84
85devhelp:
86	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
87	@echo
88	@echo "Build finished."
89	@echo "To view the help file:"
90	@echo "# mkdir -p $$HOME/.local/share/devhelp/SQLAlchemy"
91	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SQLAlchemy"
92	@echo "# devhelp"
93
94epub:
95	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
96	@echo
97	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
98
99latex:
100	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
101	cp texinputs/* $(BUILDDIR)/latex/
102	@echo
103	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
104	@echo "Run \`make' in that directory to run these through (pdf)latex" \
105	      "(use \`make latexpdf' here to do that automatically)."
106
107latexpdf:
108	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
109	@echo "Running LaTeX files through pdflatex..."
110	make -C $(BUILDDIR)/latex all-pdf
111	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
112
113text:
114	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
115	@echo
116	@echo "Build finished. The text files are in $(BUILDDIR)/text."
117
118man:
119	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
120	@echo
121	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
122
123changes:
124	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
125	@echo
126	@echo "The overview file is in $(BUILDDIR)/changes."
127
128linkcheck:
129	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
130	@echo
131	@echo "Link check complete; look for any errors in the above output " \
132	      "or in $(BUILDDIR)/linkcheck/output.txt."
133
134doctest:
135	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) .
136	@echo "Testing of doctests in the sources finished, look at the " \
137	      "results in $(BUILDDIR)/doctest/output.txt."
138