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 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 .PHONY: help checkout update build html htmlhelp latex text changes linkcheck \
  18         suspicious coverage doctest pydoc-topics htmlview clean dist check serve \
  19         autobuild-dev autobuild-stable
  20
  21 help:
  22         @echo "Please use \`make <target>' where <target> is one of"
  23         @echo "  clean      to remove build files"
  24         @echo "  update     to update build tools"
  25         @echo "  html       to make standalone HTML files"
  26         @echo "  htmlhelp   to make HTML files and a HTML help project"
  27         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  28         @echo "  text       to make plain text files"
  29         @echo "  changes    to make an overview over all changed/added/deprecated items"
  30         @echo "  linkcheck  to check all external links for integrity"
  31         @echo "  coverage   to check documentation coverage for library and C API"
  32         @echo "  doctest    to run doctests in the documentation"
  33         @echo "  pydoc-topics  to regenerate the pydoc topics file"
  34         @echo "  dist       to create a \"dist\" directory with archived docs for download"
  35         @echo "  suspicious to check for suspicious markup in output text"
  36         @echo "  check      to run a check for frequent markup errors"
  37         @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 checkout:
  41         @if [ ! -d tools/sphinx ]; then \
  42           echo "Checking out Sphinx..."; \
  43           svn checkout $(SVNROOT)/external/Sphinx-0.6.5/sphinx tools/sphinx; \
  44         fi
  45         @if [ ! -d tools/docutils ]; then \
  46           echo "Checking out Docutils..."; \
  47           svn checkout $(SVNROOT)/external/docutils-0.6/docutils tools/docutils; \
  48         fi
  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         @if [ ! -d tools/pygments ]; then \
  54           echo "Checking out Pygments..."; \
  55           svn checkout $(SVNROOT)/external/Pygments-1.3.1/pygments tools/pygments; \
  56         fi
  57
  58 update: clean checkout
  59
  60 build: checkout
  61         mkdir -p build/$(BUILDER) build/doctrees
  62         $(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
  63         @echo
  64
  65 html: BUILDER = html
  66 html: build
  67         @echo "Build finished. The HTML pages are in build/html."
  68
  69 htmlhelp: BUILDER = htmlhelp
  70 htmlhelp: build
  71         @echo "Build finished; now you can run HTML Help Workshop with the" \
  72               "build/htmlhelp/pydoc.hhp project file."
  73
  74 latex: BUILDER = latex
  75 latex: build
  76         @echo "Build finished; the LaTeX files are in build/latex."
  77         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  78               "run these through (pdf)latex."
  79
  80 text: BUILDER = text
  81 text: build
  82         @echo "Build finished; the text files are in build/text."
  83
  84 changes: BUILDER = changes
  85 changes: build
  86         @echo "The overview file is in build/changes."
  87
  88 linkcheck: BUILDER = linkcheck
  89 linkcheck: build
  90         @echo "Link check complete; look for any errors in the above output " \
  91               "or in build/$(BUILDER)/output.txt"
  92
  93 suspicious: BUILDER = suspicious
  94 suspicious: build
  95         @echo "Suspicious check complete; look for any errors in the above output " \
  96               "or in build/$(BUILDER)/suspicious.txt"
  97
  98 coverage: BUILDER = coverage
  99 coverage: build
 100         @echo "Coverage finished; see c.txt and python.txt in build/coverage"
 101
 102 doctest: BUILDER = doctest
 103 doctest: build
 104         @echo "Testing of doctests in the sources finished, look at the " \
 105               "results in build/doctest/output.txt"
 106
 107 pydoc-topics: BUILDER = pydoc-topics
 108 pydoc-topics: build
 109         @echo "Building finished; now copy build/pydoc-topics/topics.py " \
 110               "to Lib/pydoc_data/topics.py"
 111
 112 htmlview: html
 113          $(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
 114
 115 clean:
 116         -rm -rf build/*
 117         -rm -rf tools/sphinx
 118         -rm -rf tools/pygments
 119         -rm -rf tools/jinja2
 120         -rm -rf tools/docutils
 121
 122 dist:
 123         -rm -rf dist
 124         mkdir -p dist
 125
 126         # archive the HTML
 127         make html
 128         cp -pPR build/html dist/python-$(DISTVERSION)-docs-html
 129         tar -C dist -cf dist/python-$(DISTVERSION)-docs-html.tar python-$(DISTVERSION)-docs-html
 130         bzip2 -9 -k dist/python-$(DISTVERSION)-docs-html.tar
 131         (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-html.zip python-$(DISTVERSION)-docs-html)
 132         rm -r dist/python-$(DISTVERSION)-docs-html
 133         rm dist/python-$(DISTVERSION)-docs-html.tar
 134
 135         # archive the text build
 136         make text
 137         cp -pPR build/text dist/python-$(DISTVERSION)-docs-text
 138         tar -C dist -cf dist/python-$(DISTVERSION)-docs-text.tar python-$(DISTVERSION)-docs-text
 139         bzip2 -9 -k dist/python-$(DISTVERSION)-docs-text.tar
 140         (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-text.zip python-$(DISTVERSION)-docs-text)
 141         rm -r dist/python-$(DISTVERSION)-docs-text
 142         rm dist/python-$(DISTVERSION)-docs-text.tar
 143
 144         # archive the A4 latex
 145         -rm -r build/latex
 146         make latex PAPER=a4
 147         (cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
 148         cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-a4.zip
 149         cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-a4.tar.bz2
 150
 151         # archive the letter latex
 152         rm -r build/latex
 153         make latex PAPER=letter
 154         (cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
 155         cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-letter.zip
 156         cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-letter.tar.bz2
 157
 158 check:
 159         $(PYTHON) tools/rstlint.py -i tools
 160
 161 serve:
 162         ../Tools/scripts/serve.py build/html
 163
 164 # Targets for daily automated doc build
 165
 166 # for development releases: always build
 167 autobuild-dev:
 168         make update
 169         make dist SPHINXOPTS='-A daily=1'
 170
 171 # for stable releases: only build if not in pre-release stage (alpha, beta, rc)
 172 autobuild-stable:
 173         @case $(DISTVERSION) in *[abc]*) \
 174                 echo "Not building; $(DISTVERSION) is not a release version."; \
 175                 exit 1;; \
 176         esac
 177         @make autobuild-dev