Debian Codegraph @

doc/Makefile

raw ◀ ▶
Source reconstructed at patch state 1 of 2 — not the installed (fully patched) source.
2 Debian patches touch this file
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 BUILDDIR = _build
9
10 # click-specific variable
11 DEFAULT_ROOT = /opt/click.ubuntu.com
12
13 # click-specific targets
14 subst: SHELL:=/bin/bash
15 subst:
16 for file in *.rst.in; do sed -e "s,[@]DEFAULT_ROOT[@],$(DEFAULT_ROOT),g" > $${file/.rst.in/.rst} < $${file}; done
17
18 subst-clean: SHELL:=/bin/bash
19 subst-clean:
20 for file in *.rst.in; do rm -f $${file/.rst.in/.rst}; done
21 # end of click-specific targets
22
23 # Internal variables.
24 PAPEROPT_a4 = -D latex_paper_size=a4
25 PAPEROPT_letter = -D latex_paper_size=letter
26 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
27 # the i18n builder cannot share the environment and doctrees with the others
28 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
29
30 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
31
32 help:
33 @echo "Please use \`make <target>' where <target> is one of"
34 @echo " html to make standalone HTML files"
35 @echo " dirhtml to make HTML files named index.html in directories"
36 @echo " singlehtml to make a single large HTML file"
37 @echo " pickle to make pickle files"
38 @echo " json to make JSON files"
39 @echo " htmlhelp to make HTML files and a HTML help project"
40 @echo " qthelp to make HTML files and a qthelp project"
41 @echo " devhelp to make HTML files and a Devhelp project"
42 @echo " epub to make an epub"
43 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
44 @echo " latexpdf to make LaTeX files and run them through pdflatex"
45 @echo " text to make text files"
46 @echo " man to make manual pages"
47 @echo " texinfo to make Texinfo files"
48 @echo " info to make Texinfo files and run them through makeinfo"
49 @echo " gettext to make PO message catalogs"
50 @echo " changes to make an overview of all changed/added/deprecated items"
51 @echo " linkcheck to check all external links for integrity"
52 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
53
54 clean:
55 -rm -rf $(BUILDDIR)/*
56
57 html:
58 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
59 @echo
60 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
61
62 dirhtml:
63 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64 @echo
65 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66
67 singlehtml:
68 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
69 @echo
70 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
71
72 pickle:
73 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
74 @echo
75 @echo "Build finished; now you can process the pickle files."
76
77 json:
78 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
79 @echo
80 @echo "Build finished; now you can process the JSON files."
81
82 htmlhelp:
83 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
84 @echo
85 @echo "Build finished; now you can run HTML Help Workshop with the" \
86 ".hhp project file in $(BUILDDIR)/htmlhelp."
87
88 qthelp:
89 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
90 @echo
91 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
92 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
93 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ClickPackages.qhcp"
94 @echo "To view the help file:"
95 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ClickPackages.qhc"
96
97 devhelp:
98 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
99 @echo
100 @echo "Build finished."
101 @echo "To view the help file:"
102 @echo "# mkdir -p $$HOME/.local/share/devhelp/ClickPackages"
103 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ClickPackages"
104 @echo "# devhelp"
105
106 epub:
107 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
108 @echo
109 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
110
111 latex:
112 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
113 @echo
114 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
115 @echo "Run \`make' in that directory to run these through (pdf)latex" \
116 "(use \`make latexpdf' here to do that automatically)."
117
118 latexpdf:
119 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
120 @echo "Running LaTeX files through pdflatex..."
121 $(MAKE) -C $(BUILDDIR)/latex all-pdf
122 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
123
124 text:
125 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
126 @echo
127 @echo "Build finished. The text files are in $(BUILDDIR)/text."
128
129 man:
130 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
131 @echo
132 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
133
134 texinfo:
135 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
136 @echo
137 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
138 @echo "Run \`make' in that directory to run these through makeinfo" \
139 "(use \`make info' here to do that automatically)."
140
141 info:
142 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
143 @echo "Running Texinfo files through makeinfo..."
144 make -C $(BUILDDIR)/texinfo info
145 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
146
147 gettext:
148 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
149 @echo
150 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
151
152 changes:
153 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
154 @echo
155 @echo "The overview file is in $(BUILDDIR)/changes."
156
157 linkcheck:
158 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
159 @echo
160 @echo "Link check complete; look for any errors in the above output " \
161 "or in $(BUILDDIR)/linkcheck/output.txt."
162
163 doctest:
164 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
165 @echo "Testing of doctests in the sources finished, look at the " \
166 "results in $(BUILDDIR)/doctest/output.txt."