Update git submodules
[docs.git] / docs / Makefile
1 # Makefile for Sphinx documentation
2 #
3
4 # You can set these variables from the command line.
5 SPHINXOPTS    =
6 SPHINXBUILD   = sphinx-build
7 PAPER         =
8 BUILDDIR      = _build
9
10 # User-friendly check for sphinx-build
11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12   $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)
13 endif
14
15 # Internal variables.
16 PAPEROPT_a4     = -D latex_paper_size=a4
17 PAPEROPT_letter = -D latex_paper_size=letter
18 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19 # the i18n builder cannot share the environment and doctrees with the others
20 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21
22 .PHONY: help
23 help:
24         @echo "Please use \`make <target>' where <target> is one of"
25         @echo "  html       to make standalone HTML files"
26         @echo "  dirhtml    to make HTML files named index.html in directories"
27         @echo "  singlehtml to make a single large HTML file"
28         @echo "  pickle     to make pickle files"
29         @echo "  json       to make JSON files"
30         @echo "  htmlhelp   to make HTML files and a HTML help project"
31         @echo "  qthelp     to make HTML files and a qthelp project"
32         @echo "  applehelp  to make an Apple Help Book"
33         @echo "  devhelp    to make HTML files and a Devhelp project"
34         @echo "  epub       to make an epub"
35         @echo "  epub3      to make an epub3"
36         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
38         @echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
39         @echo "  text       to make text files"
40         @echo "  man        to make manual pages"
41         @echo "  texinfo    to make Texinfo files"
42         @echo "  info       to make Texinfo files and run them through makeinfo"
43         @echo "  gettext    to make PO message catalogs"
44         @echo "  changes    to make an overview of all changed/added/deprecated items"
45         @echo "  xml        to make Docutils-native XML files"
46         @echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
47         @echo "  linkcheck  to check all external links for integrity"
48         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
49         @echo "  coverage   to run coverage check of the documentation (if enabled)"
50
51 .PHONY: clean
52 clean:
53         rm -rf $(BUILDDIR)/*
54
55 .PHONY: html
56 html:
57         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
58         @echo
59         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
60
61 .PHONY: dirhtml
62 dirhtml:
63         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64         @echo
65         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66
67 .PHONY: singlehtml
68 singlehtml:
69         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
70         @echo
71         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
72
73 .PHONY: pickle
74 pickle:
75         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
76         @echo
77         @echo "Build finished; now you can process the pickle files."
78
79 .PHONY: json
80 json:
81         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
82         @echo
83         @echo "Build finished; now you can process the JSON files."
84
85 .PHONY: htmlhelp
86 htmlhelp:
87         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
88         @echo
89         @echo "Build finished; now you can run HTML Help Workshop with the" \
90               ".hhp project file in $(BUILDDIR)/htmlhelp."
91
92 .PHONY: qthelp
93 qthelp:
94         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
95         @echo
96         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
97               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
98         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenDaylightDocumentation.qhcp"
99         @echo "To view the help file:"
100         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenDaylightDocumentation.qhc"
101
102 .PHONY: applehelp
103 applehelp:
104         $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
105         @echo
106         @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
107         @echo "N.B. You won't be able to view it unless you put it in" \
108               "~/Library/Documentation/Help or install it in your application" \
109               "bundle."
110
111 .PHONY: devhelp
112 devhelp:
113         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
114         @echo
115         @echo "Build finished."
116         @echo "To view the help file:"
117         @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenDaylightDocumentation"
118         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenDaylightDocumentation"
119         @echo "# devhelp"
120
121 .PHONY: epub
122 epub:
123         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
124         @echo
125         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
126
127 .PHONY: epub3
128 epub3:
129         $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
130         @echo
131         @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
132
133 .PHONY: latex
134 latex:
135         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
136         @echo
137         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
138         @echo "Run \`make' in that directory to run these through (pdf)latex" \
139               "(use \`make latexpdf' here to do that automatically)."
140
141 .PHONY: latexpdf
142 latexpdf:
143         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
144         @echo "Running LaTeX files through pdflatex..."
145         $(MAKE) -C $(BUILDDIR)/latex all-pdf
146         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
147
148 .PHONY: latexpdfja
149 latexpdfja:
150         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
151         @echo "Running LaTeX files through platex and dvipdfmx..."
152         $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
153         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
154
155 .PHONY: text
156 text:
157         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
158         @echo
159         @echo "Build finished. The text files are in $(BUILDDIR)/text."
160
161 .PHONY: man
162 man:
163         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
164         @echo
165         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
166
167 .PHONY: texinfo
168 texinfo:
169         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
170         @echo
171         @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
172         @echo "Run \`make' in that directory to run these through makeinfo" \
173               "(use \`make info' here to do that automatically)."
174
175 .PHONY: info
176 info:
177         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
178         @echo "Running Texinfo files through makeinfo..."
179         make -C $(BUILDDIR)/texinfo info
180         @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
181
182 .PHONY: gettext
183 gettext:
184         $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
185         @echo
186         @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
187
188 .PHONY: changes
189 changes:
190         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
191         @echo
192         @echo "The overview file is in $(BUILDDIR)/changes."
193
194 .PHONY: linkcheck
195 linkcheck:
196         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
197         @echo
198         @echo "Link check complete; look for any errors in the above output " \
199               "or in $(BUILDDIR)/linkcheck/output.txt."
200
201 .PHONY: doctest
202 doctest:
203         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
204         @echo "Testing of doctests in the sources finished, look at the " \
205               "results in $(BUILDDIR)/doctest/output.txt."
206
207 .PHONY: coverage
208 coverage:
209         $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
210         @echo "Testing of coverage in the sources finished, look at the " \
211               "results in $(BUILDDIR)/coverage/python.txt."
212
213 .PHONY: xml
214 xml:
215         $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
216         @echo
217         @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
218
219 .PHONY: pseudoxml
220 pseudoxml:
221         $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
222         @echo
223         @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
224