summaryrefslogtreecommitdiffstats
path: root/Doc/Makefile
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-08-15 14:28:22 (GMT)
committerGeorg Brandl <georg@python.org>2007-08-15 14:28:22 (GMT)
commit116aa62bf54a39697e25f21d6cf6799f7faa1349 (patch)
tree8db5729518ed4ca88e26f1e26cc8695151ca3eb3 /Doc/Makefile
parent739c01d47b9118d04e5722333f0e6b4d0c8bdd9e (diff)
downloadcpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.zip
cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.gz
cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.bz2
Move the 3k reST doc tree in place.
Diffstat (limited to 'Doc/Makefile')
-rw-r--r--Doc/Makefile62
1 files changed, 62 insertions, 0 deletions
diff --git a/Doc/Makefile b/Doc/Makefile
new file mode 100644
index 0000000..955fb68
--- /dev/null
+++ b/Doc/Makefile
@@ -0,0 +1,62 @@
+#
+# Makefile for Python documentation
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#
+
+# You can set these variables from the command line.
+PYTHON ?= python
+SVNROOT ?= http://svn.python.org/projects
+SPHINXOPTS ?=
+
+ALLSPHINXOPTS = -b$(BUILDER) -dbuild/doctrees $(SPHINXOPTS) . build/$(BUILDER)
+
+.PHONY: help checkout update build html web htmlhelp clean
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " web to make file usable by Sphinx.web"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+
+checkout:
+ @if [ ! -d tools/sphinx ]; then \
+ echo "Checking out Sphinx..."; \
+ svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
+ fi
+ @if [ ! -d tools/docutils ]; then \
+ echo "Checking out Docutils..."; \
+ svn checkout $(SVNROOT)/external/docutils-0.4/docutils tools/docutils; \
+ fi
+ @if [ ! -d tools/pygments ]; then \
+ echo "Checking out Pygments..."; \
+ svn checkout $(SVNROOT)/external/Pygments-0.8.1/pygments tools/pygments; \
+ fi
+
+update:
+ svn update tools/sphinx
+ svn update tools/docutils
+ svn update tools/pygments
+
+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."
+
+web: BUILDER = web
+web: build
+ @echo "Build finished; now you can run"
+ @echo " PYTHONPATH=tools $(PYTHON) -m sphinx.web build/web"
+ @echo "to start the server."
+
+htmlhelp: BUILDER = htmlhelp
+htmlhelp: build
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ "build/hhp/pydoc.hhp project file."
+
+clean:
+ -rm -rf build/*
+ -rm -rf tools/sphinx