##// END OF EJS Templates
Fix for docs/Makefile hard-codes usage of "python" #8857
test112233 -
Show More
@@ -1,159 +1,160 b''
1 1 # Makefile for Sphinx documentation
2 2 #
3 3
4 4 # You can set these variables from the command line.
5 5 SPHINXOPTS =
6 6 SPHINXBUILD = sphinx-build
7 7 PAPER =
8 8 SRCDIR = source
9 9 BUILDDIR = build
10 PYTHON = python
10 11
11 12 # Internal variables.
12 13 PAPEROPT_a4 = -D latex_paper_size=a4
13 14 PAPEROPT_letter = -D latex_paper_size=letter
14 15 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
15 16
16 17 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
17 18
18 19 default: html
19 20
20 21 help:
21 22 @echo "Please use \`make <target>' where <target> is one of"
22 23 @echo " html standalone HTML files"
23 24 @echo " html_noapi same as above, without the time consuming API docs"
24 25 @echo " pickle pickle files (usable by e.g. sphinx-web)"
25 26 @echo " htmlhelp HTML files and a HTML help project"
26 27 @echo " latex LaTeX files, you can set PAPER=a4 or PAPER=letter"
27 28 @echo " texinfo Texinfo files"
28 29 @echo " info Texinfo files and run them through makeinfo"
29 30 @echo " changes an overview over all changed/added/deprecated items"
30 31 @echo " linkcheck check all external links for integrity (takes a long time)"
31 32 @echo " gh-pages clone IPython docs in ./gh-pages/ , build doc, autocommit"
32 33 @echo
33 34 @echo "Compound utility targets:"
34 35 @echo "pdf latex and then runs the PDF generation"
35 36 @echo "all html and pdf"
36 37 @echo "dist all, and then puts the results in dist/"
37 38
38 39 clean_api:
39 40 -rm -rf $(SRCDIR)/api/generated
40 41
41 42 clean: clean_api
42 43 -rm -rf build/* dist/*
43 44 -cd $(SRCDIR)/config/options; test -f generated && cat generated | xargs rm -f
44 45 -rm -rf $(SRCDIR)/config/options/generated
45 46 -rm -f $(SRCDIR)/interactive/magics-generated.txt
46 47
47 48 pdf: latex
48 49 cd build/latex && make all-pdf
49 50
50 51 all: html pdf
51 52
52 53 # For final distribution, only build HTML (our pdf is now so large as to be
53 54 # unusable, takes forever to build and just bloats the downloads). We leave
54 55 # them hardlinked at the top-level so users find them easily, though the
55 56 # original build/html dir is left in-place (useful to reload builds while
56 57 # testing).
57 58 dist: html
58 59 rm -rf html
59 60 cp -al build/html .
60 61 @echo "Build finished. Final docs are in html/"
61 62
62 63 html: api autoconfig automagic
63 64 html_noapi: clean_api autoconfig automagic
64 65
65 66 html html_noapi:
66 67 mkdir -p build/html build/doctrees
67 68 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
68 69 @echo
69 70 @echo "Build finished. The HTML pages are in build/html."
70 71
71 72 automagic: source/interactive/magics-generated.txt
72 73
73 74 source/interactive/magics-generated.txt: autogen_magics.py
74 python autogen_magics.py
75 $(PYTHON) autogen_magics.py
75 76 @echo "Created docs for line & cell magics"
76 77
77 78 autoconfig: source/config/options/generated
78 79
79 80 source/config/options/generated:
80 python autogen_config.py
81 $(PYTHON) autogen_config.py
81 82 @echo "Created docs for config options"
82 83
83 84 api: source/api/generated/gen.txt
84 85
85 86 source/api/generated/gen.txt:
86 python autogen_api.py
87 $(PYTHON) autogen_api.py
87 88 @echo "Build API docs finished."
88 89
89 90 pickle:
90 91 mkdir -p build/pickle build/doctrees
91 92 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
92 93 @echo
93 94 @echo "Build finished; now you can process the pickle files or run"
94 95 @echo " sphinx-web build/pickle"
95 96 @echo "to start the sphinx-web server."
96 97
97 98 web: pickle
98 99
99 100 htmlhelp:
100 101 mkdir -p build/htmlhelp build/doctrees
101 102 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
102 103 @echo
103 104 @echo "Build finished; now you can run HTML Help Workshop with the" \
104 105 ".hhp project file in build/htmlhelp."
105 106
106 107 qthelp:
107 108 mkdir -p build/qthelp
108 109 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
109 110 @echo
110 111 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
111 112 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
112 113 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp"
113 114 @echo "To view the help file:"
114 115 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc"
115 116
116 117 latex: api autoconfig
117 118 mkdir -p build/latex build/doctrees
118 119 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
119 120 @echo
120 121 @echo "Build finished; the LaTeX files are in build/latex."
121 122 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
122 123 "run these through (pdf)latex."
123 124
124 125 changes:
125 126 mkdir -p build/changes build/doctrees
126 127 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
127 128 @echo
128 129 @echo "The overview file is in build/changes."
129 130
130 131 linkcheck:
131 132 mkdir -p build/linkcheck build/doctrees
132 133 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
133 134 @echo
134 135 @echo "Link check complete; look for any errors in the above output " \
135 136 "or in build/linkcheck/output.rst."
136 137
137 138 nightly: dist
138 139 rsync -avH --delete dist/ ipython:www/doc/nightly
139 140
140 141 gh-pages: clean html
141 142 # if VERSION is unspecified, it will be dev
142 143 # For releases, VERSION should be just the major version,
143 144 # e.g. VERSION=2 make gh-pages
144 python gh-pages.py $(VERSION)
145 $(PYTHON) gh-pages.py $(VERSION)
145 146
146 147 texinfo:
147 148 mkdir -p $(BUILDDIR)/texinfo
148 149 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
149 150 @echo
150 151 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
151 152 @echo "Run \`make' in that directory to run these through makeinfo" \
152 153 "(use \`make info' here to do that automatically)."
153 154
154 155 info:
155 156 mkdir -p $(BUILDDIR)/texinfo
156 157 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
157 158 @echo "Running Texinfo files through makeinfo..."
158 159 make -C $(BUILDDIR)/texinfo info
159 160 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
General Comments 0
You need to be logged in to leave comments. Login now