blob: 22f852be6b006cf04eb1f8860221770aeab2b412 [file] [log] [blame]
Georg Brandl116aa622007-08-15 14:28:22 +00001#
2# Makefile for Python documentation
3# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4#
5
6# You can set these variables from the command line.
Guido van Rossumba9c9ac2007-08-18 00:03:44 +00007PYTHON = python2.5
Guido van Rossumda27fd22007-08-17 00:24:54 +00008SVNROOT = http://svn.python.org/projects
9SPHINXOPTS =
Christian Heimes2c181612007-12-17 20:04:13 +000010PAPER =
Georg Brandl116aa622007-08-15 14:28:22 +000011
Christian Heimes2c181612007-12-17 20:04:13 +000012ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
13 $(SPHINXOPTS) . build/$(BUILDER)
Georg Brandl116aa622007-08-15 14:28:22 +000014
15.PHONY: help checkout update build html web htmlhelp clean
16
17help:
18 @echo "Please use \`make <target>' where <target> is one of"
Christian Heimes2c181612007-12-17 20:04:13 +000019 @echo " html to make standalone HTML files"
20 @echo " web to make file usable by Sphinx.web"
Georg Brandl116aa622007-08-15 14:28:22 +000021 @echo " htmlhelp to make HTML files and a HTML help project"
Christian Heimes2c181612007-12-17 20:04:13 +000022 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
Georg Brandl116aa622007-08-15 14:28:22 +000023
24checkout:
25 @if [ ! -d tools/sphinx ]; then \
26 echo "Checking out Sphinx..."; \
27 svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
28 fi
29 @if [ ! -d tools/docutils ]; then \
30 echo "Checking out Docutils..."; \
31 svn checkout $(SVNROOT)/external/docutils-0.4/docutils tools/docutils; \
32 fi
33 @if [ ! -d tools/pygments ]; then \
34 echo "Checking out Pygments..."; \
Georg Brandld1cdf212007-10-23 18:21:41 +000035 svn checkout $(SVNROOT)/external/Pygments-0.9/pygments tools/pygments; \
Georg Brandl116aa622007-08-15 14:28:22 +000036 fi
37
Thomas Woutersbca54802007-09-10 19:32:14 +000038update: checkout
Georg Brandl116aa622007-08-15 14:28:22 +000039 svn update tools/sphinx
40 svn update tools/docutils
41 svn update tools/pygments
42
43build: checkout
44 mkdir -p build/$(BUILDER) build/doctrees
45 $(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
46 @echo
47
48html: BUILDER = html
49html: build
50 @echo "Build finished. The HTML pages are in build/html."
51
52web: BUILDER = web
53web: build
54 @echo "Build finished; now you can run"
55 @echo " PYTHONPATH=tools $(PYTHON) -m sphinx.web build/web"
56 @echo "to start the server."
57
58htmlhelp: BUILDER = htmlhelp
59htmlhelp: build
60 @echo "Build finished; now you can run HTML Help Workshop with the" \
Guido van Rossumda27fd22007-08-17 00:24:54 +000061 "build/htmlhelp/pydoc.hhp project file."
Georg Brandl116aa622007-08-15 14:28:22 +000062
Christian Heimesd8654cf2007-12-02 15:22:16 +000063latex: BUILDER = latex
64latex: build
65 @echo "Build finished; the LaTeX files are in build/latex."
Christian Heimes2c181612007-12-17 20:04:13 +000066 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
67 "run these through (pdf)latex."
Christian Heimesd8654cf2007-12-02 15:22:16 +000068
Georg Brandl116aa622007-08-15 14:28:22 +000069clean:
70 -rm -rf build/*
71 -rm -rf tools/sphinx