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