← Back to branch summary

~speijnik/python-argvalidate/devel

« back to all changes in this revision

Viewing changes to doc/Makefile

  • Committer: Stephan Peijnik
  • Date: 2010-04-23 18:10:11 UTC
  • Revision ID: debian@sp.or.at-20100423181011-u1uo3ui7do6qw7gm
Initial import from HG tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Makefile
 
1
# Makefile for Sphinx documentation
 
2
#
 
3
 
 
4
# You can set these variables from the command line.
 
5
SPHINXOPTS    =
 
6
SPHINXBUILD   = sphinx-build
 
7
PAPER         =
 
8
 
 
9
# Internal variables.
 
10
PAPEROPT_a4     = -D latex_paper_size=a4
 
11
PAPEROPT_letter = -D latex_paper_size=letter
 
12
ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
13
 
 
14
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
 
15
 
 
16
help:
 
17
        @echo "Please use \`make <target>' where <target> is one of"
 
18
        @echo "  html      to make standalone HTML files"
 
19
        @echo "  pickle    to make pickle files (usable by e.g. sphinx-web)"
 
20
        @echo "  htmlhelp  to make HTML files and a HTML help project"
 
21
        @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 
22
        @echo "  changes   to make an overview over all changed/added/deprecated items"
 
23
        @echo "  linkcheck to check all external links for integrity"
 
24
 
 
25
clean:
 
26
        -rm -rf _build/*
 
27
        -touch _build/keep
 
28
 
 
29
html:
 
30
        mkdir -p _build/html _build/doctrees
 
31
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
 
32
        @echo
 
33
        @echo "Build finished. The HTML pages are in _build/html."
 
34
 
 
35
pickle:
 
36
        mkdir -p _build/pickle _build/doctrees
 
37
        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
 
38
        @echo
 
39
        @echo "Build finished; now you can process the pickle files or run"
 
40
        @echo "  sphinx-web _build/pickle"
 
41
        @echo "to start the sphinx-web server."
 
42
 
 
43
web: pickle
 
44
 
 
45
htmlhelp:
 
46
        mkdir -p _build/htmlhelp _build/doctrees
 
47
        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
 
48
        @echo
 
49
        @echo "Build finished; now you can run HTML Help Workshop with the" \
 
50
              ".hhp project file in _build/htmlhelp."
 
51
 
 
52
latex:
 
53
        mkdir -p _build/latex _build/doctrees
 
54
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
 
55
        @echo
 
56
        @echo "Build finished; the LaTeX files are in _build/latex."
 
57
        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
 
58
              "run these through (pdf)latex."
 
59
 
 
60
changes:
 
61
        mkdir -p _build/changes _build/doctrees
 
62
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
 
63
        @echo
 
64
        @echo "The overview file is in _build/changes."
 
65
 
 
66
linkcheck:
 
67
        mkdir -p _build/linkcheck _build/doctrees
 
68
        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
 
69
        @echo
 
70
        @echo "Link check complete; look for any errors in the above output " \
 
71
              "or in _build/linkcheck/output.txt."