Makefile 6.05 KB
Newer Older
1 2 3 4 5 6
#
# Makefile for Python documentation
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#

# You can set these variables from the command line.
7 8 9
PYTHON       = python
SVNROOT      = http://svn.python.org/projects
SPHINXOPTS   =
10
PAPER        =
11
SOURCES      =
12
DISTVERSION  = $(shell $(PYTHON) tools/sphinxext/patchlevel.py)
13

14
ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
15
                $(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
16

17 18 19
.PHONY: help checkout update build html htmlhelp latex text changes linkcheck \
	suspicious coverage doctest pydoc-topics htmlview clean dist check serve \
	autobuild-dev autobuild-stable
20 21 22

help:
	@echo "Please use \`make <target>' where <target> is one of"
23 24 25 26 27 28 29 30 31 32 33 34
	@echo "  clean      to remove build files"
	@echo "  update     to update build tools"
	@echo "  html       to make standalone HTML files"
	@echo "  htmlhelp   to make HTML files and a HTML help project"
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	@echo "  text       to make plain text files"
	@echo "  changes    to make an overview over all changed/added/deprecated items"
	@echo "  linkcheck  to check all external links for integrity"
	@echo "  coverage   to check documentation coverage for library and C API"
	@echo "  doctest    to run doctests in the documentation"
	@echo "  pydoc-topics  to regenerate the pydoc topics file"
	@echo "  dist       to create a \"dist\" directory with archived docs for download"
35
	@echo "  suspicious to check for suspicious markup in output text"
36 37
	@echo "  check      to run a check for frequent markup errors"
	@echo "  serve      to serve the documentation on the localhost (8000)"
38

39
# Note: if you update versions here, do the same in make.bat and README.txt
40 41 42
checkout:
	@if [ ! -d tools/sphinx ]; then \
	  echo "Checking out Sphinx..."; \
43
	  svn checkout $(SVNROOT)/external/Sphinx-0.6.5/sphinx tools/sphinx; \
44 45 46
	fi
	@if [ ! -d tools/docutils ]; then \
	  echo "Checking out Docutils..."; \
47
	  svn checkout $(SVNROOT)/external/docutils-0.6/docutils tools/docutils; \
48
	fi
Benjamin Peterson's avatar
Benjamin Peterson committed
49
	@if [ ! -d tools/jinja2 ]; then \
50
	  echo "Checking out Jinja..."; \
51
	  svn checkout $(SVNROOT)/external/Jinja-2.3.1/jinja2 tools/jinja2; \
52
	fi
53 54
	@if [ ! -d tools/pygments ]; then \
	  echo "Checking out Pygments..."; \
55
	  svn checkout $(SVNROOT)/external/Pygments-1.3.1/pygments tools/pygments; \
56 57
	fi

58
update: clean checkout
59 60 61 62 63 64 65 66 67 68 69 70 71

build: checkout
	mkdir -p build/$(BUILDER) build/doctrees
	$(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
	@echo

html: BUILDER = html
html: build
	@echo "Build finished. The HTML pages are in build/html."

htmlhelp: BUILDER = htmlhelp
htmlhelp: build
	@echo "Build finished; now you can run HTML Help Workshop with the" \
72
	      "build/htmlhelp/pydoc.hhp project file."
73

74 75 76
latex: BUILDER = latex
latex: build
	@echo "Build finished; the LaTeX files are in build/latex."
77 78
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
	      "run these through (pdf)latex."
79

Georg Brandl's avatar
Georg Brandl committed
80 81 82 83
text: BUILDER = text
text: build
	@echo "Build finished; the text files are in build/text."

Georg Brandl's avatar
Georg Brandl committed
84 85 86 87
changes: BUILDER = changes
changes: build
	@echo "The overview file is in build/changes."

88 89
linkcheck: BUILDER = linkcheck
linkcheck: build
90
	@echo "Link check complete; look for any errors in the above output " \
Georg Brandl's avatar
Georg Brandl committed
91
	      "or in build/$(BUILDER)/output.txt"
92

93 94 95 96 97
suspicious: BUILDER = suspicious
suspicious: build
	@echo "Suspicious check complete; look for any errors in the above output " \
	      "or in build/$(BUILDER)/suspicious.txt"

98 99 100 101
coverage: BUILDER = coverage
coverage: build
	@echo "Coverage finished; see c.txt and python.txt in build/coverage"

102 103 104 105 106
doctest: BUILDER = doctest
doctest: build
	@echo "Testing of doctests in the sources finished, look at the " \
	      "results in build/doctest/output.txt"

107 108
pydoc-topics: BUILDER = pydoc-topics
pydoc-topics: build
109 110
	@echo "Building finished; now copy build/pydoc-topics/topics.py " \
	      "to Lib/pydoc_data/topics.py"
111

Benjamin Peterson's avatar
Benjamin Peterson committed
112 113
htmlview: html
	 $(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
Georg Brandl's avatar
Georg Brandl committed
114

115 116 117
clean:
	-rm -rf build/*
	-rm -rf tools/sphinx
118 119 120
	-rm -rf tools/pygments
	-rm -rf tools/jinja2
	-rm -rf tools/docutils
Georg Brandl's avatar
Georg Brandl committed
121 122 123 124 125 126 127

dist:
	-rm -rf dist
	mkdir -p dist

	# archive the HTML
	make html
128 129 130 131 132 133
	cp -pPR build/html dist/python-$(DISTVERSION)-docs-html
	tar -C dist -cf dist/python-$(DISTVERSION)-docs-html.tar python-$(DISTVERSION)-docs-html
	bzip2 -9 -k dist/python-$(DISTVERSION)-docs-html.tar
	(cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-html.zip python-$(DISTVERSION)-docs-html)
	rm -r dist/python-$(DISTVERSION)-docs-html
	rm dist/python-$(DISTVERSION)-docs-html.tar
Georg Brandl's avatar
Georg Brandl committed
134 135 136

	# archive the text build
	make text
137 138 139 140 141 142
	cp -pPR build/text dist/python-$(DISTVERSION)-docs-text
	tar -C dist -cf dist/python-$(DISTVERSION)-docs-text.tar python-$(DISTVERSION)-docs-text
	bzip2 -9 -k dist/python-$(DISTVERSION)-docs-text.tar
	(cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-text.zip python-$(DISTVERSION)-docs-text)
	rm -r dist/python-$(DISTVERSION)-docs-text
	rm dist/python-$(DISTVERSION)-docs-text.tar
143

Georg Brandl's avatar
Georg Brandl committed
144 145 146
	# archive the A4 latex
	-rm -r build/latex
	make latex PAPER=a4
147
	-sed -i 's/makeindex/makeindex -q/' build/latex/Makefile
Georg Brandl's avatar
Georg Brandl committed
148
	(cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
149 150
	cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-a4.zip
	cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-a4.tar.bz2
Georg Brandl's avatar
Georg Brandl committed
151 152 153 154

	# archive the letter latex
	rm -r build/latex
	make latex PAPER=letter
155
	-sed -i 's/makeindex/makeindex -q/' build/latex/Makefile
Georg Brandl's avatar
Georg Brandl committed
156
	(cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
157 158
	cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-letter.zip
	cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-letter.tar.bz2
Georg Brandl's avatar
Georg Brandl committed
159

160
check:
161
	$(PYTHON) tools/rstlint.py -i tools
162 163 164

serve:
	../Tools/scripts/serve.py build/html
165

166
# Targets for daily automated doc build
167 168 169 170

# for development releases: always build
autobuild-dev:
	make update
171
	make dist SPHINXOPTS='-A daily=1'
172

173
# for stable releases: only build if not in pre-release stage (alpha, beta, rc)
174 175
autobuild-stable:
	@case $(DISTVERSION) in *[abc]*) \
176 177
		echo "Not building; $(DISTVERSION) is not a release version."; \
		exit 1;; \
178 179
	esac
	@make autobuild-dev