2 # Makefile for Python documentation
3 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6 # You can set these variables from the command line.
8 SVNROOT
= http
://svn.python.org
/projects
12 DISTVERSION
= $(shell $(PYTHON
) tools
/sphinxext
/patchlevel.py
)
14 ALLSPHINXOPTS
= -b
$(BUILDER
) -d build
/doctrees
-D latex_paper_size
=$(PAPER
) \
15 $(SPHINXOPTS
) . build
/$(BUILDER
) $(SOURCES
)
17 .PHONY
: help checkout update build html htmlhelp
clean coverage
dist check
20 @echo
"Please use \`make <target>' where <target> is one of"
21 @echo
" html to make standalone HTML files"
22 @echo
" htmlhelp to make HTML files and a HTML help project"
23 @echo
" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
24 @echo
" text to make plain text files"
25 @echo
" changes to make an overview over all changed/added/deprecated items"
26 @echo
" linkcheck to check all external links for integrity"
27 @echo
" suspicious to check for suspicious markup in output text"
28 @echo
" coverage to check documentation coverage for library and C API"
29 @echo
" dist to create a \"dist\" directory with archived docs for download"
31 # Note: if you update versions here, do the same in make.bat and README.txt
33 @if
[ ! -d tools
/sphinx
]; then \
34 echo
"Checking out Sphinx..."; \
35 svn checkout
$(SVNROOT
)/external
/Sphinx-0.6
.3/sphinx tools
/sphinx
; \
37 @if
[ ! -d tools
/docutils
]; then \
38 echo
"Checking out Docutils..."; \
39 svn checkout
$(SVNROOT
)/external
/docutils-0.5
/docutils tools
/docutils
; \
41 @if
[ ! -d tools
/jinja2
]; then \
42 echo
"Checking out Jinja..."; \
43 svn checkout
$(SVNROOT
)/external
/Jinja-2.1
.1/jinja2 tools
/jinja2
; \
45 @if
[ ! -d tools
/pygments
]; then \
46 echo
"Checking out Pygments..."; \
47 svn checkout
$(SVNROOT
)/external
/Pygments-1.1
.1/pygments tools
/pygments
; \
50 update
: clean checkout
53 mkdir
-p build
/$(BUILDER
) build
/doctrees
54 $(PYTHON
) tools
/sphinx-build.py
$(ALLSPHINXOPTS
)
59 @echo
"Build finished. The HTML pages are in build/html."
61 htmlhelp
: BUILDER
= htmlhelp
63 @echo
"Build finished; now you can run HTML Help Workshop with the" \
64 "build/htmlhelp/pydoc.hhp project file."
66 latex
: BUILDER
= latex
68 @echo
"Build finished; the LaTeX files are in build/latex."
69 @echo
"Run \`make all-pdf' or \`make all-ps' in that directory to" \
70 "run these through (pdf)latex."
74 @echo
"Build finished; the text files are in build/text."
76 changes
: BUILDER
= changes
78 @echo
"The overview file is in build/changes."
80 linkcheck
: BUILDER
= linkcheck
82 @echo
"Link check complete; look for any errors in the above output " \
83 "or in build/$(BUILDER)/output.txt"
85 suspicious
: BUILDER
= suspicious
87 @echo
"Suspicious check complete; look for any errors in the above output " \
88 "or in build/$(BUILDER)/suspicious.txt"
90 coverage
: BUILDER
= coverage
92 @echo
"Coverage finished; see c.txt and python.txt in build/coverage"
94 doctest
: BUILDER
= doctest
96 @echo
"Testing of doctests in the sources finished, look at the " \
97 "results in build/doctest/output.txt"
99 pydoc-topics
: BUILDER
= pydoc-topics
101 @echo
"Building finished; now copy build/pydoc-topics/topics.py " \
102 "to Lib/pydoc_data/topics.py"
105 $(PYTHON
) -c
"import webbrowser; webbrowser.open('build/html/index.html')"
110 -rm -rf tools
/pygments
112 -rm -rf tools
/docutils
120 cp
-pPR build
/html
dist/python-
$(DISTVERSION
)-docs-html
121 tar -C
dist -cf
dist/python-
$(DISTVERSION
)-docs-html.
tar python-
$(DISTVERSION
)-docs-html
122 bzip2
-9 -k
dist/python-
$(DISTVERSION
)-docs-html.
tar
123 (cd
dist; zip
-q
-r
-9 python-
$(DISTVERSION
)-docs-html.zip python-
$(DISTVERSION
)-docs-html
)
124 rm -r
dist/python-
$(DISTVERSION
)-docs-html
125 rm dist/python-
$(DISTVERSION
)-docs-html.
tar
127 # archive the text build
129 cp
-pPR build
/text
dist/python-
$(DISTVERSION
)-docs-text
130 tar -C
dist -cf
dist/python-
$(DISTVERSION
)-docs-text.
tar python-
$(DISTVERSION
)-docs-text
131 bzip2
-9 -k
dist/python-
$(DISTVERSION
)-docs-text.
tar
132 (cd
dist; zip
-q
-r
-9 python-
$(DISTVERSION
)-docs-text.zip python-
$(DISTVERSION
)-docs-text
)
133 rm -r
dist/python-
$(DISTVERSION
)-docs-text
134 rm dist/python-
$(DISTVERSION
)-docs-text.
tar
136 # archive the A4 latex
139 (cd build
/latex
; make
clean && make all-pdf
&& make FMT
=pdf zip bz2
)
140 cp build
/latex
/docs-pdf.zip
dist/python-
$(DISTVERSION
)-docs-pdf-a4.zip
141 cp build
/latex
/docs-pdf.
tar.bz2
dist/python-
$(DISTVERSION
)-docs-pdf-a4.
tar.bz2
143 # archive the letter latex
145 make latex PAPER
=letter
146 (cd build
/latex
; make
clean && make all-pdf
&& make FMT
=pdf zip bz2
)
147 cp build
/latex
/docs-pdf.zip
dist/python-
$(DISTVERSION
)-docs-pdf-letter.zip
148 cp build
/latex
/docs-pdf.
tar.bz2
dist/python-
$(DISTVERSION
)-docs-pdf-letter.
tar.bz2
151 $(PYTHON
) tools
/rstlint.py
-i tools