OLD | NEW |
1 # Makefile for Sphinx documentation | 1 # Makefile for Sphinx documentation |
2 # | 2 # |
3 | 3 |
4 # You can set these variables from the command line. | 4 # You can set these variables from the command line. |
5 SPHINXOPTS = -W | 5 SPHINXOPTS = -W |
6 SPHINXBUILD = sphinx-build | 6 SPHINXBUILD = sphinx-build |
7 PAPER = | 7 PAPER = |
8 BUILDDIR = _build | 8 BUILDDIR = _build |
9 | 9 |
10 # User-friendly check for sphinx-build | 10 # User-friendly check for sphinx-build |
11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) | 11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in
stalled, then set the SPHINXBUILD environment variable to point to the full path
of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory wit
h the executable to your PATH. If you don't have Sphinx installed, grab it from
http://sphinx-doc.org/) | 12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in
stalled, then set the SPHINXBUILD environment variable to point to the full path
of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory wit
h the executable to your PATH. If you don't have Sphinx installed, grab it from
http://sphinx-doc.org/) |
13 endif | 13 endif |
14 | 14 |
15 # Internal variables. | 15 # Internal variables. |
16 PAPEROPT_a4 = -D latex_paper_size=a4 | 16 PAPEROPT_a4 = -D latex_paper_size=a4 |
17 PAPEROPT_letter = -D latex_paper_size=letter | 17 PAPEROPT_letter = -D latex_paper_size=letter |
18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | 18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
19 # the i18n builder cannot share the environment and doctrees with the others | 19 # the i18n builder cannot share the environment and doctrees with the others |
20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | 20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
21 | 21 |
22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp e
pub latex latexpdf text man changes linkcheck doctest gettext all | 22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp e
pub latex latexpdf text man changes linkcheck doctest gettext all |
23 | 23 |
24 all: devsite | 24 all: devsite |
25 | 25 |
26 help: | 26 help: |
27 @echo "Please use \`make <target>' where <target> is one of" | 27 @echo "Please use \`make <target>' where <target> is one of" |
28 » @echo " html to make standalone HTML files" | 28 » @echo " html to make standalone HTML files" |
29 » @echo " dirhtml to make HTML files named index.html in directories" | 29 » @echo " dirhtml to make HTML files named index.html in directories
" |
30 » @echo " singlehtml to make a single large HTML file" | 30 » @echo " singlehtml to make a single large HTML file" |
31 » @echo " pickle to make pickle files" | 31 » @echo " pickle to make pickle files" |
32 » @echo " json to make JSON files" | 32 » @echo " json to make JSON files" |
33 » @echo " htmlhelp to make HTML files and a HTML help project" | 33 » @echo " htmlhelp to make HTML files and a HTML help project" |
34 » @echo " qthelp to make HTML files and a qthelp project" | 34 » @echo " qthelp to make HTML files and a qthelp project" |
35 » @echo " devhelp to make HTML files and a Devhelp project" | 35 » @echo " devhelp to make HTML files and a Devhelp project" |
36 » @echo " epub to make an epub" | 36 » @echo " epub to make an epub" |
37 » @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=l
etter" | 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" | 38 » @echo " latexpdf to make LaTeX files and run them through pdflatex" |
39 » @echo " latexpdfja to make LaTeX files and run them through platex/dvip
dfmx" | 39 » @echo " latexpdfja to make LaTeX files and run them through platex/dv
ipdfmx" |
40 » @echo " text to make text files" | 40 » @echo " text to make text files" |
41 » @echo " man to make manual pages" | 41 » @echo " man to make manual pages" |
42 » @echo " texinfo to make Texinfo files" | 42 » @echo " texinfo to make Texinfo files" |
43 » @echo " info to make Texinfo files and run them through makeinfo" | 43 » @echo " info to make Texinfo files and run them through makeinf
o" |
44 » @echo " gettext to make PO message catalogs" | 44 » @echo " gettext to make PO message catalogs" |
45 » @echo " changes to make an overview of all changed/added/deprecated
items" | 45 » @echo " changes to make an overview of all changed/added/deprecate
d items" |
46 » @echo " xml to make Docutils-native XML files" | 46 » @echo " xml to make Docutils-native XML files" |
47 » @echo " pseudoxml to make pseudoxml-XML files for display purposes" | 47 » @echo " pseudoxml to make pseudoxml-XML files for display purposes" |
48 » @echo " linkcheck to check all external links for integrity" | 48 » @echo " linkcheck to check all external links for integrity" |
49 » @echo " doctest to run all doctests embedded in the documentation (i
f enabled)" | 49 » @echo " doctest to run all doctests embedded in the documentation
(if enabled)" |
50 » @echo " devsite build docs for developer.google.com" | 50 » @echo " devsite build locally viewable version of docs for develop
er.google.com" |
51 » @echo " serve start python web server on port server 8009" | 51 » @echo " devsite-prod build production docs for developer.google.com" |
| 52 » @echo " serve start python web server on port server 8009" |
52 | 53 |
53 clean: | 54 clean: |
54 rm -rf $(BUILDDIR)/* | 55 rm -rf $(BUILDDIR)/* |
55 | 56 |
56 html: | 57 html: |
57 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | 58 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
58 @echo | 59 @echo |
59 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | 60 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
60 | 61 |
61 dirhtml: | 62 dirhtml: |
(...skipping 111 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
173 xml: | 174 xml: |
174 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml | 175 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml |
175 @echo | 176 @echo |
176 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." | 177 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." |
177 | 178 |
178 pseudoxml: | 179 pseudoxml: |
179 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml | 180 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml |
180 @echo | 181 @echo |
181 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml
." | 182 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml
." |
182 | 183 |
| 184 devsite-prod: |
| 185 $(SPHINXBUILD) -b devsite -D devsite_production_mode=1 $(ALLSPHINXOPTS)
$(BUILDDIR)/devsite-prod |
| 186 @echo |
| 187 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-prod." |
| 188 |
183 devsite: | 189 devsite: |
184 » $(SPHINXBUILD) -b devsite $(ALLSPHINXOPTS) $(BUILDDIR)/devsite | 190 » $(SPHINXBUILD) -b devsite -D devsite_production_mode=0 $(ALLSPHINXOPTS)
$(BUILDDIR)/devsite |
| 191 » @echo |
| 192 » @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite." |
185 | 193 |
186 serve: | 194 serve: |
187 cd _build/devsite && python -m SimpleHTTPServer 8009 | 195 cd _build/devsite && python -m SimpleHTTPServer 8009 |
OLD | NEW |