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