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 clean coverage dist check
  18
  19 help:
  20         @echo "Please use \`make <target>' where <target> is one of"
  21         @echo "  html      to make standalone HTML files"
  22         @echo "  htmlhelp  to make HTML files and a HTML help project"
  23         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  24         @echo "  text      to make plain text files"
  25         @echo "  changes   to make an overview over all changed/added/deprecated items"
  26         @echo "  linkcheck to check all external links for integrity"
  27         @echo "  suspicious to check for suspicious markup in output text"
  28         @echo "  coverage  to check documentation coverage for library and C API"
  29         @echo "  dist      to create a \"dist\" directory with archived docs for download"
  30
  31 # Note: if you update versions here, do the same in make.bat and README.txt
  32 checkout:
  33         @if [ ! -d tools/sphinx ]; then \
  34           echo "Checking out Sphinx..."; \
  35           svn checkout $(SVNROOT)/external/Sphinx-0.6.3/sphinx tools/sphinx; \
  36         fi
  37         @if [ ! -d tools/docutils ]; then \
  38           echo "Checking out Docutils..."; \
  39           svn checkout $(SVNROOT)/external/docutils-0.5/docutils tools/docutils; \
  40         fi
  41         @if [ ! -d tools/jinja2 ]; then \
  42           echo "Checking out Jinja..."; \
  43           svn checkout $(SVNROOT)/external/Jinja-2.1.1/jinja2 tools/jinja2; \
  44         fi
  45         @if [ ! -d tools/pygments ]; then \
  46           echo "Checking out Pygments..."; \
  47           svn checkout $(SVNROOT)/external/Pygments-1.1.1/pygments tools/pygments; \
  48         fi
  49
  50 update: clean checkout
  51
  52 build: checkout
  53         mkdir -p build/$(BUILDER) build/doctrees
  54         $(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
  55         @echo
  56
  57 html: BUILDER = html
  58 html: build
  59         @echo "Build finished. The HTML pages are in build/html."
  60
  61 htmlhelp: BUILDER = htmlhelp
  62 htmlhelp: build
  63         @echo "Build finished; now you can run HTML Help Workshop with the" \
  64               "build/htmlhelp/pydoc.hhp project file."
  65
  66 latex: BUILDER = latex
  67 latex: build
  68         @echo "Build finished; the LaTeX files are in build/latex."
  69         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  70               "run these through (pdf)latex."
  71
  72 text: BUILDER = text
  73 text: build
  74         @echo "Build finished; the text files are in build/text."
  75
  76 changes: BUILDER = changes
  77 changes: build
  78         @echo "The overview file is in build/changes."
  79
  80 linkcheck: BUILDER = linkcheck
  81 linkcheck: build
  82         @echo "Link check complete; look for any errors in the above output " \
  83               "or in build/$(BUILDER)/output.txt"
  84
  85 suspicious: BUILDER = suspicious
  86 suspicious: build
  87         @echo "Suspicious check complete; look for any errors in the above output " \
  88               "or in build/$(BUILDER)/suspicious.txt"
  89
  90 coverage: BUILDER = coverage
  91 coverage: build
  92         @echo "Coverage finished; see c.txt and python.txt in build/coverage"
  93
  94 doctest: BUILDER = doctest
  95 doctest: build
  96         @echo "Testing of doctests in the sources finished, look at the " \
  97               "results in build/doctest/output.txt"
  98
  99 pydoc-topics: BUILDER = pydoc-topics
 100 pydoc-topics: build
 101         @echo "Building finished; now copy build/pydoc-topics/topics.py " \
 102               "to Lib/pydoc_data/topics.py"
 103
 104 htmlview: html
 105          $(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
 106
 107 clean:
 108         -rm -rf build/*
 109         -rm -rf tools/sphinx
 110         -rm -rf tools/pygments
 111         -rm -rf tools/jinja2
 112         -rm -rf tools/docutils
 113
 114 dist:
 115         -rm -rf dist
 116         mkdir -p dist
 117
 118         # archive the HTML
 119         make html
 120         cp -pPR build/html dist/python-$(DISTVERSION)-docs-html
 121         tar -C dist -cf dist/python-$(DISTVERSION)-docs-html.tar python-$(DISTVERSION)-docs-html
 122         bzip2 -9 -k dist/python-$(DISTVERSION)-docs-html.tar
 123         (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-html.zip python-$(DISTVERSION)-docs-html)
 124         rm -r dist/python-$(DISTVERSION)-docs-html
 125         rm dist/python-$(DISTVERSION)-docs-html.tar
 126
 127         # archive the text build
 128         make text
 129         cp -pPR build/text dist/python-$(DISTVERSION)-docs-text
 130         tar -C dist -cf dist/python-$(DISTVERSION)-docs-text.tar python-$(DISTVERSION)-docs-text
 131         bzip2 -9 -k dist/python-$(DISTVERSION)-docs-text.tar
 132         (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-text.zip python-$(DISTVERSION)-docs-text)
 133         rm -r dist/python-$(DISTVERSION)-docs-text
 134         rm dist/python-$(DISTVERSION)-docs-text.tar
 135
 136         # archive the A4 latex
 137         -rm -r build/latex
 138         make latex PAPER=a4
 139         (cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
 140         cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-a4.zip
 141         cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-a4.tar.bz2
 142
 143         # archive the letter latex
 144         rm -r build/latex
 145         make latex PAPER=letter
 146         (cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
 147         cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-letter.zip
 148         cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-letter.tar.bz2
 149
 150 check:
 151         $(PYTHON) tools/rstlint.py -i tools