1 # Makefile for Sphinx documentation
4 # You can set these variables from the command line.
6 SPHINXBUILD = sphinx-build
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/)
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) .
22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext all
27 @echo "Please use \`make <target>' where <target> is one of"
28 @echo " html to make standalone HTML files"
29 @echo " dirhtml to make HTML files named index.html in directories"
30 @echo " singlehtml to make a single large HTML file"
31 @echo " pickle to make pickle files"
32 @echo " json to make JSON files"
33 @echo " htmlhelp to make HTML files and a HTML help project"
34 @echo " qthelp to make HTML files and a qthelp project"
35 @echo " devhelp to make HTML files and a Devhelp project"
36 @echo " epub to make an epub"
37 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
38 @echo " latexpdf to make LaTeX files and run them through pdflatex"
39 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
40 @echo " text to make text files"
41 @echo " man to make manual pages"
42 @echo " texinfo to make Texinfo files"
43 @echo " info to make Texinfo files and run them through makeinfo"
44 @echo " gettext to make PO message catalogs"
45 @echo " changes to make an overview of all changed/added/deprecated items"
46 @echo " xml to make Docutils-native XML files"
47 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
48 @echo " linkcheck to check all external links for integrity"
49 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
50 @echo " devsite build locally viewable version of docs for developer.google.com"
51 @echo " devsite-prod build production docs for developer.google.com"
52 @echo " serve start python web server on port server 8009"
58 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
60 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
63 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
65 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
68 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
70 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
73 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
75 @echo "Build finished; now you can process the pickle files."
78 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
80 @echo "Build finished; now you can process the JSON files."
83 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
85 @echo "Build finished; now you can run HTML Help Workshop with the" \
86 ".hhp project file in $(BUILDDIR)/htmlhelp."
89 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
91 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
92 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
93 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NativeClient.qhcp"
94 @echo "To view the help file:"
95 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NativeClient.qhc"
98 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
100 @echo "Build finished."
101 @echo "To view the help file:"
102 @echo "# mkdir -p $$HOME/.local/share/devhelp/NativeClient"
103 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NativeClient"
107 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
109 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
112 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
114 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
115 @echo "Run \`make' in that directory to run these through (pdf)latex" \
116 "(use \`make latexpdf' here to do that automatically)."
119 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
120 @echo "Running LaTeX files through pdflatex..."
121 $(MAKE) -C $(BUILDDIR)/latex all-pdf
122 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
125 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
126 @echo "Running LaTeX files through platex and dvipdfmx..."
127 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
128 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
131 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
133 @echo "Build finished. The text files are in $(BUILDDIR)/text."
136 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
138 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
141 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
143 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
144 @echo "Run \`make' in that directory to run these through makeinfo" \
145 "(use \`make info' here to do that automatically)."
148 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
149 @echo "Running Texinfo files through makeinfo..."
150 make -C $(BUILDDIR)/texinfo info
151 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
154 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
156 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
159 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
161 @echo "The overview file is in $(BUILDDIR)/changes."
164 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
166 @echo "Link check complete; look for any errors in the above output " \
167 "or in $(BUILDDIR)/linkcheck/output.txt."
170 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
171 @echo "Testing of doctests in the sources finished, look at the " \
172 "results in $(BUILDDIR)/doctest/output.txt."
175 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
177 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
180 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
182 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
185 $(SPHINXBUILD) -b devsite -D devsite_production_mode=1 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-prod
186 rm -rf $(BUILDDIR)/devsite-prod/images
187 cp -r $(BUILDDIR)/devsite-prod/_images $(BUILDDIR)/devsite-prod/images
189 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-prod."
192 $(SPHINXBUILD) -b devsite -D devsite_foldername=$(USER) -D devsite_production_mode=1 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-staging
193 rm -rf $(BUILDDIR)/devsite-staging/images
194 cp -r $(BUILDDIR)/devsite-staging/_images $(BUILDDIR)/devsite-staging/images
195 cp _reference_toc.yaml $(BUILDDIR)/devsite-staging/
197 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-staging."
200 $(SPHINXBUILD) -b devsite -D devsite_production_mode=0 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite
202 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite."
205 cd _build/devsite && python -m SimpleHTTPServer 8009