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 PAPER        =
  11
  12 ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
  13                 $(SPHINXOPTS) . build/$(BUILDER)
  14
  15 .PHONY: help checkout update build html web htmlhelp clean
  16
  17 help:
  18         @echo "Please use \`make <target>' where <target> is one of"
  19         @echo "  html     to make standalone HTML files"
  20         @echo "  web      to make file usable by Sphinx.web"
  21         @echo "  htmlhelp to make HTML files and a HTML help project"
  22         @echo "  latex    to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  23         @echo "  changes  to make an overview over all changed/added/deprecated items"
  24
  25 checkout:
  26         @if [ ! -d tools/sphinx ]; then \
  27           echo "Checking out Sphinx..."; \
  28           svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
  29         fi
  30         @if [ ! -d tools/docutils ]; then \
  31           echo "Checking out Docutils..."; \
  32           svn checkout $(SVNROOT)/external/docutils-0.4/docutils tools/docutils; \
  33         fi
  34         @if [ ! -d tools/pygments ]; then \
  35           echo "Checking out Pygments..."; \
  36           svn checkout $(SVNROOT)/external/Pygments-0.9/pygments tools/pygments; \
  37         fi
  38
  39 update: checkout
  40         svn update tools/sphinx
  41         svn update tools/docutils
  42         svn update tools/pygments
  43
  44 build: checkout
  45         mkdir -p build/$(BUILDER) build/doctrees
  46         $(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
  47         @echo
  48
  49 html: BUILDER = html
  50 html: build
  51         @echo "Build finished. The HTML pages are in build/html."
  52
  53 web: BUILDER = web
  54 web: build
  55         @echo "Build finished; now you can run"
  56         @echo "  PYTHONPATH=tools $(PYTHON) -m sphinx.web build/web"
  57         @echo "to start the server."
  58
  59 htmlhelp: BUILDER = htmlhelp
  60 htmlhelp: build
  61         @echo "Build finished; now you can run HTML Help Workshop with the" \
  62               "build/htmlhelp/pydoc.hhp project file."
  63
  64 latex: BUILDER = latex
  65 latex: build
  66         @echo "Build finished; the LaTeX files are in build/latex."
  67         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  68               "run these through (pdf)latex."
  69
  70 changes: BUILDER = changes
  71 changes: build
  72         @echo "The overview file is in build/changes."
  73
  74 clean:
  75         -rm -rf build/*
  76         -rm -rf tools/sphinx