Mercurial > cpython-lru_cache-weakref

annotate Doc/Makefile @ 70817:dd775b1561ba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix markup.
author Georg Brandl <georg@python.org>
date Tue, 14 Jun 2011 21:09:55 +0200
parents 3c9232a684ae
children 8acdaf766644
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
1 #
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
2 # Makefile for Python documentation
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
3 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
4 #
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
5
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
6 # You can set these variables from the command line.
51987
7d69070a3d78 don't bother with version in doc builds
Benjamin Peterson <benjamin@python.org>
parents: 50649
diff changeset
7 PYTHON = python
42630
20aec9f34598 Manually patched a few things that didn't get merged in, but should.
Guido van Rossum <guido@python.org>
parents: 42604
diff changeset
8 SVNROOT = http://svn.python.org/projects
20aec9f34598 Manually patched a few things that didn't get merged in, but should.
Guido van Rossum <guido@python.org>
parents: 42604
diff changeset
9 SPHINXOPTS =
44329
75c6bfd3b1f3 Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44104
diff changeset
10 PAPER =
46034
0a485593ae1c Merged revisions 61724-61725,61731-61735,61737,61739,61741,61743-61744,61753,61761,61765-61767,61769,61773,61776-61778,61780-61783,61788,61793,61796,61807,61813 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45495
diff changeset
11 SOURCES =
50364
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
12 DISTVERSION = $(shell $(PYTHON) tools/sphinxext/patchlevel.py)
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
13
44329
75c6bfd3b1f3 Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44104
diff changeset
14 ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
46034
0a485593ae1c Merged revisions 61724-61725,61731-61735,61737,61739,61741,61743-61744,61753,61761,61765-61767,61769,61773,61776-61778,61780-61783,61788,61793,61796,61807,61813 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45495
diff changeset
15 $(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
16
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
17 .PHONY: help checkout update build html htmlhelp latex text changes linkcheck \
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
18 suspicious coverage doctest pydoc-topics htmlview clean dist check serve \
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
19 autobuild-dev autobuild-stable
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
20
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
21 help:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
22 @echo "Please use \`make <target>' where <target> is one of"
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
23 @echo " clean to remove build files"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
24 @echo " update to update build tools"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
25 @echo " html to make standalone HTML files"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
26 @echo " htmlhelp to make HTML files and a HTML help project"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
27 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
28 @echo " text to make plain text files"
67375
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
29 @echo " epub to make EPUB files"
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
30 @echo " changes to make an overview over all changed/added/deprecated items"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
31 @echo " linkcheck to check all external links for integrity"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
32 @echo " coverage to check documentation coverage for library and C API"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
33 @echo " doctest to run doctests in the documentation"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
34 @echo " pydoc-topics to regenerate the pydoc topics file"
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
35 @echo " dist to create a \"dist\" directory with archived docs for download"
50649
72fe51d6f800 Merged revisions 68427 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50565
diff changeset
36 @echo " suspicious to check for suspicious markup in output text"
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
37 @echo " check to run a check for frequent markup errors"
59575
ad017d1b8072 Merged revisions 78908 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59571
diff changeset
38 @echo " serve to serve the documentation on the localhost (8000)"
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
39
53515
8068ab51632d Merged revisions 71960 via svnmerge from
Georg Brandl <georg@python.org>
parents: 52431
diff changeset
40 # Note: if you update versions here, do the same in make.bat and README.txt
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
41 checkout:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
42 @if [ ! -d tools/sphinx ]; then \
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
43 echo "Checking out Sphinx..."; \
67618
4a20e3ca25e9 Update to 1.0.7.
Georg Brandl <georg@python.org>
parents: 67375
diff changeset
44 svn checkout $(SVNROOT)/external/Sphinx-1.0.7/sphinx tools/sphinx; \
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
45 fi
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
46 @if [ ! -d tools/docutils ]; then \
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
47 echo "Checking out Docutils..."; \
59572
b1b22c60222b Merged revisions 78911 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58028
diff changeset
48 svn checkout $(SVNROOT)/external/docutils-0.6/docutils tools/docutils; \
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
49 fi
50649
72fe51d6f800 Merged revisions 68427 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50565
diff changeset
50 @if [ ! -d tools/jinja2 ]; then \
46439
46879e7fc4d3 Merged revisions 62332 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 46034
diff changeset
51 echo "Checking out Jinja..."; \
59572
b1b22c60222b Merged revisions 78911 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58028
diff changeset
52 svn checkout $(SVNROOT)/external/Jinja-2.3.1/jinja2 tools/jinja2; \
46439
46879e7fc4d3 Merged revisions 62332 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 46034
diff changeset
53 fi
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
54 @if [ ! -d tools/pygments ]; then \
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
55 echo "Checking out Pygments..."; \
59572
b1b22c60222b Merged revisions 78911 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58028
diff changeset
56 svn checkout $(SVNROOT)/external/Pygments-1.3.1/pygments tools/pygments; \
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
57 fi
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
58
58028
4d6d952fe288 Merged revisions 77151-77152 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 58010
diff changeset
59 update: clean checkout
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
60
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
61 build: checkout
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
62 mkdir -p build/$(BUILDER) build/doctrees
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
63 $(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
64 @echo
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
65
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
66 html: BUILDER = html
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
67 html: build
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
68 @echo "Build finished. The HTML pages are in build/html."
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
69
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
70 htmlhelp: BUILDER = htmlhelp
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
71 htmlhelp: build
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
72 @echo "Build finished; now you can run HTML Help Workshop with the" \
42630
20aec9f34598 Manually patched a few things that didn't get merged in, but should.
Guido van Rossum <guido@python.org>
parents: 42604
diff changeset
73 "build/htmlhelp/pydoc.hhp project file."
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
74
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43648
diff changeset
75 latex: BUILDER = latex
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43648
diff changeset
76 latex: build
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43648
diff changeset
77 @echo "Build finished; the LaTeX files are in build/latex."
44329
75c6bfd3b1f3 Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44104
diff changeset
78 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
75c6bfd3b1f3 Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44104
diff changeset
79 "run these through (pdf)latex."
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43648
diff changeset
80
47555
7d824fd131ad Merged revisions 63829-63831,63858,63865,63879,63882,63948,63970-63972,63976,63989,64014-64015,64021-64022,64063-64065,64067 via svnmerge from
Georg Brandl <georg@python.org>
parents: 47432
diff changeset
81 text: BUILDER = text
7d824fd131ad Merged revisions 63829-63831,63858,63865,63879,63882,63948,63970-63972,63976,63989,64014-64015,64021-64022,64063-64065,64067 via svnmerge from
Georg Brandl <georg@python.org>
parents: 47432
diff changeset
82 text: build
7d824fd131ad Merged revisions 63829-63831,63858,63865,63879,63882,63948,63970-63972,63976,63989,64014-64015,64021-64022,64063-64065,64067 via svnmerge from
Georg Brandl <georg@python.org>
parents: 47432
diff changeset
83 @echo "Build finished; the text files are in build/text."
7d824fd131ad Merged revisions 63829-63831,63858,63865,63879,63882,63948,63970-63972,63976,63989,64014-64015,64021-64022,64063-64065,64067 via svnmerge from
Georg Brandl <georg@python.org>
parents: 47432
diff changeset
84
67375
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
85 epub: BUILDER = epub
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
86 epub: build
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
87 @echo "Build finished; the epub files are in build/epub."
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
88
44396
6556f3f22c19 Merged revisions 59605-59624 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44329
diff changeset
89 changes: BUILDER = changes
6556f3f22c19 Merged revisions 59605-59624 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44329
diff changeset
90 changes: build
6556f3f22c19 Merged revisions 59605-59624 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44329
diff changeset
91 @echo "The overview file is in build/changes."
6556f3f22c19 Merged revisions 59605-59624 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44329
diff changeset
92
45134
bdcf40d1b38e Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
93 linkcheck: BUILDER = linkcheck
bdcf40d1b38e Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
94 linkcheck: build
65145
2d99edc4f10d Merged revisions 85276 via svnmerge from
Georg Brandl <georg@python.org>
parents: 63680
diff changeset
95 @echo "Link check complete; look for any errors in the above output" \
45134
bdcf40d1b38e Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
96 "or in build/$(BUILDER)/output.txt"
bdcf40d1b38e Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
97
50649
72fe51d6f800 Merged revisions 68427 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50565
diff changeset
98 suspicious: BUILDER = suspicious
72fe51d6f800 Merged revisions 68427 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50565
diff changeset
99 suspicious: build
65145
2d99edc4f10d Merged revisions 85276 via svnmerge from
Georg Brandl <georg@python.org>
parents: 63680
diff changeset
100 @echo "Suspicious check complete; look for any errors in the above output" \
2d99edc4f10d Merged revisions 85276 via svnmerge from
Georg Brandl <georg@python.org>
parents: 63680
diff changeset
101 "or in build/$(BUILDER)/suspicious.csv. If all issues are false" \
2d99edc4f10d Merged revisions 85276 via svnmerge from
Georg Brandl <georg@python.org>
parents: 63680
diff changeset
102 "positives, append that file to tools/sphinxext/susp-ignored.csv."
50649
72fe51d6f800 Merged revisions 68427 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50565
diff changeset
103
45495
48488fa50729 Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45134
diff changeset
104 coverage: BUILDER = coverage
48488fa50729 Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45134
diff changeset
105 coverage: build
48488fa50729 Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45134
diff changeset
106 @echo "Coverage finished; see c.txt and python.txt in build/coverage"
48488fa50729 Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45134
diff changeset
107
46034
0a485593ae1c Merged revisions 61724-61725,61731-61735,61737,61739,61741,61743-61744,61753,61761,61765-61767,61769,61773,61776-61778,61780-61783,61788,61793,61796,61807,61813 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45495
diff changeset
108 doctest: BUILDER = doctest
0a485593ae1c Merged revisions 61724-61725,61731-61735,61737,61739,61741,61743-61744,61753,61761,61765-61767,61769,61773,61776-61778,61780-61783,61788,61793,61796,61807,61813 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45495
diff changeset
109 doctest: build
65145
2d99edc4f10d Merged revisions 85276 via svnmerge from
Georg Brandl <georg@python.org>
parents: 63680
diff changeset
110 @echo "Testing of doctests in the sources finished, look at the" \
46034
0a485593ae1c Merged revisions 61724-61725,61731-61735,61737,61739,61741,61743-61744,61753,61761,61765-61767,61769,61773,61776-61778,61780-61783,61788,61793,61796,61807,61813 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45495
diff changeset
111 "results in build/doctest/output.txt"
0a485593ae1c Merged revisions 61724-61725,61731-61735,61737,61739,61741,61743-61744,61753,61761,61765-61767,61769,61773,61776-61778,61780-61783,61788,61793,61796,61807,61813 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45495
diff changeset
112
47432
31d2ff8696bd Merged revisions 63871 via svnmerge from
Georg Brandl <georg@python.org>
parents: 46439
diff changeset
113 pydoc-topics: BUILDER = pydoc-topics
31d2ff8696bd Merged revisions 63871 via svnmerge from
Georg Brandl <georg@python.org>
parents: 46439
diff changeset
114 pydoc-topics: build
65145
2d99edc4f10d Merged revisions 85276 via svnmerge from
Georg Brandl <georg@python.org>
parents: 63680
diff changeset
115 @echo "Building finished; now copy build/pydoc-topics/topics.py" \
53515
8068ab51632d Merged revisions 71960 via svnmerge from
Georg Brandl <georg@python.org>
parents: 52431
diff changeset
116 "to Lib/pydoc_data/topics.py"
47432
31d2ff8696bd Merged revisions 63871 via svnmerge from
Georg Brandl <georg@python.org>
parents: 46439
diff changeset
117
48412
5f4a8980c1ac Merged revisions 64475,64544-64545,64550,64557-64558,64565,64570,64577,64582-64583,64585,64590,64592-64593,64625,64630,64638,64647,64655-64656,64663-64664 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 47555
diff changeset
118 htmlview: html
5f4a8980c1ac Merged revisions 64475,64544-64545,64550,64557-64558,64565,64570,64577,64582-64583,64585,64590,64592-64593,64625,64630,64638,64647,64655-64656,64663-64664 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 47555
diff changeset
119 $(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
120
42604
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
121 clean:
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
122 -rm -rf build/*
9e1529bf0442 Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff changeset
123 -rm -rf tools/sphinx
58028
4d6d952fe288 Merged revisions 77151-77152 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 58010
diff changeset
124 -rm -rf tools/pygments
4d6d952fe288 Merged revisions 77151-77152 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 58010
diff changeset
125 -rm -rf tools/jinja2
4d6d952fe288 Merged revisions 77151-77152 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 58010
diff changeset
126 -rm -rf tools/docutils
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
127
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
128 dist:
63680
45dba22a74fc Merged revisions 83663 via svnmerge from
Georg Brandl <georg@python.org>
parents: 62949
diff changeset
129 rm -rf dist
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
130 mkdir -p dist
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
131
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
132 # archive the HTML
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
133 make html
50364
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
134 cp -pPR build/html dist/python-$(DISTVERSION)-docs-html
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
135 tar -C dist -cf dist/python-$(DISTVERSION)-docs-html.tar python-$(DISTVERSION)-docs-html
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
136 bzip2 -9 -k dist/python-$(DISTVERSION)-docs-html.tar
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
137 (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-html.zip python-$(DISTVERSION)-docs-html)
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
138 rm -r dist/python-$(DISTVERSION)-docs-html
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
139 rm dist/python-$(DISTVERSION)-docs-html.tar
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
140
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
141 # archive the text build
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
142 make text
50364
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
143 cp -pPR build/text dist/python-$(DISTVERSION)-docs-text
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
144 tar -C dist -cf dist/python-$(DISTVERSION)-docs-text.tar python-$(DISTVERSION)-docs-text
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
145 bzip2 -9 -k dist/python-$(DISTVERSION)-docs-text.tar
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
146 (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-text.zip python-$(DISTVERSION)-docs-text)
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
147 rm -r dist/python-$(DISTVERSION)-docs-text
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
148 rm dist/python-$(DISTVERSION)-docs-text.tar
53515
8068ab51632d Merged revisions 71960 via svnmerge from
Georg Brandl <georg@python.org>
parents: 52431
diff changeset
149
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
150 # archive the A4 latex
63680
45dba22a74fc Merged revisions 83663 via svnmerge from
Georg Brandl <georg@python.org>
parents: 62949
diff changeset
151 rm -rf build/latex
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
152 make latex PAPER=a4
62949
424e3fcfd3ad Merged revisions 82789 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59585
diff changeset
153 -sed -i 's/makeindex/makeindex -q/' build/latex/Makefile
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
154 (cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
50364
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
155 cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-a4.zip
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
156 cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-a4.tar.bz2
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
157
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
158 # archive the letter latex
63680
45dba22a74fc Merged revisions 83663 via svnmerge from
Georg Brandl <georg@python.org>
parents: 62949
diff changeset
159 rm -rf build/latex
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
160 make latex PAPER=letter
62949
424e3fcfd3ad Merged revisions 82789 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59585
diff changeset
161 -sed -i 's/makeindex/makeindex -q/' build/latex/Makefile
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
162 (cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
50364
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
163 cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-letter.zip
3d447b7b1363 Merged revisions 67948-67950 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49493
diff changeset
164 cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-letter.tar.bz2
49274
1d5c3bcf35ad Merged revisions 66508,66510,66512-66513,66523-66526,66529-66530,66532,66535,66538,66544,66546 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 49114
diff changeset
165
67375
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
166 # archive the epub build
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
167 rm -rf build/epub
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
168 make epub
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
169 mkdir -p dist/python-$(DISTVERSION)-docs-epub
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
170 cp -pPR build/epub/*.epub dist/python-$(DISTVERSION)-docs-epub/
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
171 tar -C dist -cf dist/python-$(DISTVERSION)-docs-epub.tar python-$(DISTVERSION)-docs-epub
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
172 bzip2 -9 -k dist/python-$(DISTVERSION)-docs-epub.tar
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
173 (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-epub.zip python-$(DISTVERSION)-docs-epub)
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
174 rm -r dist/python-$(DISTVERSION)-docs-epub
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
175 rm dist/python-$(DISTVERSION)-docs-epub.tar
a44badf9e00f #10130: Prepare for building epub-format docs.
Georg Brandl <georg@python.org>
parents: 66164
diff changeset
176
50561
b96d61688b87 Merged revisions 68223 via svnmerge from
Georg Brandl <georg@python.org>
parents: 50364
diff changeset
177 check:
50565
afac0cabc3ad Merged revisions 68228 via svnmerge from
Georg Brandl <georg@python.org>
parents: 50561
diff changeset
178 $(PYTHON) tools/rstlint.py -i tools
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
179
59478
c870396b6ae1 Merged revisions 78416,78430 via svnmerge from
R. David Murray <rdmurray@bitdance.com>
parents: 58028
diff changeset
180 serve:
c870396b6ae1 Merged revisions 78416,78430 via svnmerge from
R. David Murray <rdmurray@bitdance.com>
parents: 58028
diff changeset
181 ../Tools/scripts/serve.py build/html
59575
ad017d1b8072 Merged revisions 78908 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59571
diff changeset
182
59585
19e9660d9aa5 Merged revisions 78924 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59576
diff changeset
183 # Targets for daily automated doc build
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
184
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
185 # for development releases: always build
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
186 autobuild-dev:
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
187 make update
59585
19e9660d9aa5 Merged revisions 78924 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59576
diff changeset
188 make dist SPHINXOPTS='-A daily=1'
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
189
59585
19e9660d9aa5 Merged revisions 78924 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59576
diff changeset
190 # for stable releases: only build if not in pre-release stage (alpha, beta, rc)
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
191 autobuild-stable:
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
192 @case $(DISTVERSION) in *[abc]*) \
59585
19e9660d9aa5 Merged revisions 78924 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59576
diff changeset
193 echo "Not building; $(DISTVERSION) is not a release version."; \
19e9660d9aa5 Merged revisions 78924 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59576
diff changeset
194 exit 1;; \
59576
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
195 esac
5a6e897064d6 Merged revisions 78915 via svnmerge from
Georg Brandl <georg@python.org>
parents: 59572
diff changeset
196 @make autobuild-dev