1
# Makefile for Sphinx documentation
4
# You can set these variables from the command line.
6
SPHINXBUILD = sphinx-build
11
PAPEROPT_a4 = -D latex_paper_size=a4
12
PAPEROPT_letter = -D latex_paper_size=letter
13
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14
# the i18n builder cannot share the environment and doctrees with the others
15
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
17
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
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)"
47
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
49
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
52
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
54
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
57
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
59
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
62
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
64
@echo "Build finished; now you can process the pickle files."
67
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
69
@echo "Build finished; now you can process the JSON files."
72
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
74
@echo "Build finished; now you can run HTML Help Workshop with the" \
75
".hhp project file in $(BUILDDIR)/htmlhelp."
78
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
80
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
81
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
82
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/llvm.qhcp"
83
@echo "To view the help file:"
84
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/llvm.qhc"
87
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
89
@echo "Build finished."
90
@echo "To view the help file:"
91
@echo "# mkdir -p $$HOME/.local/share/devhelp/llvm"
92
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/llvm"
96
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
98
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
101
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
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)."
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."
114
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
116
@echo "Build finished. The text files are in $(BUILDDIR)/text."
119
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
121
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
124
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
126
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
127
@echo "Run \`make' in that directory to run these through makeinfo" \
128
"(use \`make info' here to do that automatically)."
131
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
132
@echo "Running Texinfo files through makeinfo..."
133
make -C $(BUILDDIR)/texinfo info
134
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
137
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
139
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
142
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
144
@echo "The overview file is in $(BUILDDIR)/changes."
147
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
149
@echo "Link check complete; look for any errors in the above output " \
150
"or in $(BUILDDIR)/linkcheck/output.txt."
153
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
154
@echo "Testing of doctests in the sources finished, look at the " \
155
"results in $(BUILDDIR)/doctest/output.txt."