Commit | Line | Data |
---|---|---|
72b9787e JB |
1 | # Makefile for (Sphinx based) restructured text documentation |
2 | # | |
3 | ||
4 | # You can set these variables from the command line. | |
5 | SPHINXOPTS = | |
6 | SPHINXBUILD = sphinx-build | |
7 | PAPER = | |
8 | ||
9 | QCOLLECTIONGENERATOR = qcollectiongenerator | |
10 | ||
11 | # Internal variables. | |
12 | PAPEROPT_a4 = -D latex_paper_size=a4 | |
13 | PAPEROPT_letter = -D latex_paper_size=letter | |
14 | ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |
15 | ||
b53f7c52 | 16 | .PHONY: help clean distclean html web pickle htmlhelp qthelp qhc latex changes linkcheck |
72b9787e JB |
17 | |
18 | help: | |
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" | |
b53f7c52 | 27 | @echo " man to make manpages" |
72b9787e JB |
28 | @echo " changes to make an overview over all changed/added/deprecated items" |
29 | @echo " linkcheck to check all external links for integrity" | |
30 | ||
31 | clean: | |
32 | -rm -rf build/* | |
33 | ||
b53f7c52 JB |
34 | distclean: clean |
35 | -rmdir build/ | |
36 | ||
72b9787e JB |
37 | html: |
38 | mkdir -p build/html build/doctrees | |
39 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html | |
40 | @echo | |
41 | @echo "Build finished. The HTML pages are in build/html." | |
42 | ||
43 | zip: html | |
44 | (cd build ; zip TortoiseHg.html.zip -r html) | |
45 | ||
46 | pickle: | |
47 | mkdir -p build/pickle build/doctrees | |
48 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle | |
49 | @echo | |
50 | @echo "Build finished; now you can process the pickle files." | |
51 | ||
52 | web: pickle | |
53 | ||
54 | json: | |
55 | mkdir -p build/json build/doctrees | |
56 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json | |
57 | @echo | |
58 | @echo "Build finished; now you can process the JSON files." | |
59 | ||
60 | htmlhelp: | |
61 | mkdir -p build/htmlhelp build/doctrees | |
62 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp | |
63 | @echo | |
64 | @echo "Build finished; now you can run HTML Help Workshop with the" \ | |
65 | ".hhp project file in build/htmlhelp." | |
66 | ||
67 | qthelp: | |
68 | mkdir -p build/qthelp build/doctrees | |
69 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp | |
70 | @echo | |
71 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ | |
72 | ".qhcp project file in build/qthelp, like this:" | |
73 | @echo "# qcollectiongenerator build/qthelp/foo.qhcp" | |
74 | @echo "To view the help file:" | |
75 | @echo "# assistant -collectionFile build/qthelp/foo.qhc" | |
76 | ||
77 | qhc: qthelp | |
78 | $(QCOLLECTIONGENERATOR) build/qthelp/TortoiseHg.qhcp | |
79 | @echo "Build finished. To view the help file:" | |
80 | @echo "# assistant -collectionFile build/qthelp/TortoiseHg.qhc" | |
81 | ||
82 | latex: | |
83 | mkdir -p build/latex build/doctrees | |
84 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex | |
85 | @echo | |
86 | @echo "Build finished; the LaTeX files are in build/latex." | |
87 | @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ | |
88 | "run these through (pdf)latex." | |
89 | ||
b53f7c52 JB |
90 | man: |
91 | mkdir -p build/man build/doctrees | |
92 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) build/man | |
93 | @echo | |
94 | @echo "Build finished; the manpages are in build/man." | |
95 | @echo "Run \`man -l build/man/x265.1' or \`man -l build/man/libx265.3'" \ | |
96 | "to view them." | |
97 | ||
72b9787e JB |
98 | changes: |
99 | mkdir -p build/changes build/doctrees | |
100 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes | |
101 | @echo | |
102 | @echo "The overview file is in build/changes." | |
103 | ||
104 | linkcheck: | |
105 | mkdir -p build/linkcheck build/doctrees | |
106 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck | |
107 | @echo | |
108 | @echo "Link check complete; look for any errors in the above output " \ | |
109 | "or in build/linkcheck/output.txt." |