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