Debian Codegraph @

doc/Makefile

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