Doc/Makefile

   1 #
   2 # Makefile for Python documentation
   3 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   4 #
   5
   6 # You can set these variables from the command line.
   7 PYTHON       = python
   8 SVNROOT      = http://svn.python.org/projects
   9 SPHINXOPTS   =
  10
  11 ALLSPHINXOPTS = -b$(BUILDER) -dbuild/doctrees $(SPHINXOPTS) . build/$(BUILDER)
  12
  13 .PHONY: help checkout update build html web htmlhelp clean
  14
  15 help:
  16         @echo "Please use \`make <target>' where <target> is one of"
  17         @echo "  html  to make standalone HTML files"
  18         @echo "  web   to make file usable by Sphinx.web"
  19         @echo "  htmlhelp to make HTML files and a HTML help project"
  20
  21 checkout:
  22         @if [ ! -d tools/sphinx ]; then \
  23           echo "Checking out Sphinx..."; \
  24           svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
  25         fi
  26         @if [ ! -d tools/docutils ]; then \
  27           echo "Checking out Docutils..."; \
  28           svn checkout $(SVNROOT)/external/docutils-0.4/docutils tools/docutils; \
  29         fi
  30         @if [ ! -d tools/pygments ]; then \
  31           echo "Checking out Pygments..."; \
  32           svn checkout $(SVNROOT)/external/Pygments-0.8.1/pygments tools/pygments; \
  33         fi
  34
  35 update:
  36         svn update tools/sphinx
  37         svn update tools/docutils
  38         svn update tools/pygments
  39
  40 build: checkout
  41         mkdir -p build/$(BUILDER) build/doctrees
  42         $(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
  43         @echo
  44
  45 html: BUILDER = html
  46 html: build
  47         @echo "Build finished. The HTML pages are in build/html."
  48
  49 web: BUILDER = web
  50 web: build
  51         @echo "Build finished; now you can run"
  52         @echo "  PYTHONPATH=tools $(PYTHON) -m sphinx.web build/web"
  53         @echo "to start the server."
  54
  55 htmlhelp: BUILDER = htmlhelp
  56 htmlhelp: build
  57         @echo "Build finished; now you can run HTML Help Workshop with the" \
  58               "build/htmlhelp/pydoc.hhp project file."
  59
  60 clean:
  61         -rm -rf build/*
  62         -rm -rf tools/sphinx