Update changelog.
[deb_x265.git] / doc / reST / Makefile
... / ...
CommitLineData
1# Makefile for (Sphinx based) restructured text documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS =
6SPHINXBUILD = sphinx-build
7PAPER =
8
9QCOLLECTIONGENERATOR = qcollectiongenerator
10
11# Internal variables.
12PAPEROPT_a4 = -D latex_paper_size=a4
13PAPEROPT_letter = -D latex_paper_size=letter
14ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
15
16.PHONY: help clean html web pickle htmlhelp qthelp qhc latex changes linkcheck
17
18help:
19 @echo "Please use \`make <target>' where <target> is one of"
20 @echo " html to make standalone HTML files"
21 @echo " pickle to make pickle files"
22 @echo " json to make JSON files"
23 @echo " htmlhelp to make HTML files and a HTML help project"
24 @echo " qthelp to make HTML files and a qthelp project"
25 @echo " qhc to make QHC file"
26 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
27 @echo " changes to make an overview over all changed/added/deprecated items"
28 @echo " linkcheck to check all external links for integrity"
29
30clean:
31 -rm -rf build/*
32
33html:
34 mkdir -p build/html build/doctrees
35 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
36 @echo
37 @echo "Build finished. The HTML pages are in build/html."
38
39zip: html
40 (cd build ; zip TortoiseHg.html.zip -r html)
41
42pickle:
43 mkdir -p build/pickle build/doctrees
44 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
45 @echo
46 @echo "Build finished; now you can process the pickle files."
47
48web: pickle
49
50json:
51 mkdir -p build/json build/doctrees
52 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
53 @echo
54 @echo "Build finished; now you can process the JSON files."
55
56htmlhelp:
57 mkdir -p build/htmlhelp build/doctrees
58 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
59 @echo
60 @echo "Build finished; now you can run HTML Help Workshop with the" \
61 ".hhp project file in build/htmlhelp."
62
63qthelp:
64 mkdir -p build/qthelp build/doctrees
65 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
66 @echo
67 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
68 ".qhcp project file in build/qthelp, like this:"
69 @echo "# qcollectiongenerator build/qthelp/foo.qhcp"
70 @echo "To view the help file:"
71 @echo "# assistant -collectionFile build/qthelp/foo.qhc"
72
73qhc: qthelp
74 $(QCOLLECTIONGENERATOR) build/qthelp/TortoiseHg.qhcp
75 @echo "Build finished. To view the help file:"
76 @echo "# assistant -collectionFile build/qthelp/TortoiseHg.qhc"
77
78latex:
79 mkdir -p build/latex build/doctrees
80 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
81 @echo
82 @echo "Build finished; the LaTeX files are in build/latex."
83 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
84 "run these through (pdf)latex."
85
86changes:
87 mkdir -p build/changes build/doctrees
88 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
89 @echo
90 @echo "The overview file is in build/changes."
91
92linkcheck:
93 mkdir -p build/linkcheck build/doctrees
94 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
95 @echo
96 @echo "Link check complete; look for any errors in the above output " \
97 "or in build/linkcheck/output.txt."