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