Debian Codegraph @

docs/Makefile

raw
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 DOT_DIAGRAMS := $(wildcard images/*.dot)
10 MSC_DIAGRAMS := $(wildcard images/*.mscgen)
11 GPI_DIAGRAMS := $(wildcard images/*.gpi)
12 SVG_IMAGES := $(wildcard images/*.svg) $(DOT_DIAGRAMS:%.dot=%.svg) $(MSC_DIAGRAMS:%.mscgen=%.svg)
13 PNG_IMAGES := $(wildcard images/*.png) $(GPI_DIAGRAMS:%.gpi=%.png) $(SVG_IMAGES:%.svg=%.png)
14 PDF_IMAGES := $(SVG_IMAGES:%.svg=%.pdf) $(GPI_DIAGRAMS:%.gpi=%.pdf) $(DOT_DIAGRAMS:%.dot=%.pdf) $(MSC_DIAGRAMS:%.mscgen=%.pdf)
15 INKSCAPE_VER := $(shell inkscape --version | sed -ne '/^Inkscape/ s/^Inkscape \([0-9]\+\)\..*$$/\1/p')
16
17 # User-friendly check for sphinx-build
18 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
19 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
20 endif
21
22 # Internal variables.
23 PAPEROPT_a4 = -D latex_paper_size=a4
24 PAPEROPT_letter = -D latex_paper_size=letter
25 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
26 # the i18n builder cannot share the environment and doctrees with the others
27 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
28
29 help:
30 @echo "Please use \`make <target>' where <target> is one of"
31 @echo " html to make standalone HTML files"
32 @echo " dirhtml to make HTML files named index.html in directories"
33 @echo " singlehtml to make a single large HTML file"
34 @echo " pickle to make pickle files"
35 @echo " json to make JSON files"
36 @echo " htmlhelp to make HTML files and a HTML help project"
37 @echo " qthelp to make HTML files and a qthelp project"
38 @echo " devhelp to make HTML files and a Devhelp project"
39 @echo " epub to make an epub"
40 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
41 @echo " latexpdf to make LaTeX files and run them through pdflatex"
42 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
43 @echo " text to make text files"
44 @echo " man to make manual pages"
45 @echo " texinfo to make Texinfo files"
46 @echo " info to make Texinfo files and run them through makeinfo"
47 @echo " gettext to make PO message catalogs"
48 @echo " changes to make an overview of all changed/added/deprecated items"
49 @echo " xml to make Docutils-native XML files"
50 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
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: $(SVG_IMAGES) $(PNG_IMAGES)
58 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
59 @echo
60 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
61
62 dirhtml: $(SVG_IMAGES) $(PNG_IMAGES)
63 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64 @echo
65 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66
67 singlehtml: $(SVG_IMAGES) $(PNG_IMAGES)
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/colorzero.qhcp"
94 @echo "To view the help file:"
95 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/colorzero.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/colorzero"
103 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/colorzero"
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: $(PDF_IMAGES)
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: $(PDF_IMAGES)
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 latexpdfja: $(PDF_IMAGES)
125 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
126 @echo "Running LaTeX files through platex and dvipdfmx..."
127 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
128 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
129
130 text:
131 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
132 @echo
133 @echo "Build finished. The text files are in $(BUILDDIR)/text."
134
135 man:
136 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
137 @echo
138 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
139
140 texinfo:
141 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
142 @echo
143 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
144 @echo "Run \`make' in that directory to run these through makeinfo" \
145 "(use \`make info' here to do that automatically)."
146
147 info:
148 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
149 @echo "Running Texinfo files through makeinfo..."
150 make -C $(BUILDDIR)/texinfo info
151 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
152
153 gettext:
154 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
155 @echo
156 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
157
158 changes:
159 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
160 @echo
161 @echo "The overview file is in $(BUILDDIR)/changes."
162
163 linkcheck:
164 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
165 @echo
166 @echo "Link check complete; look for any errors in the above output " \
167 "or in $(BUILDDIR)/linkcheck/output.txt."
168
169 doctest:
170 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
171 @echo "Testing of doctests in the sources finished, look at the " \
172 "results in $(BUILDDIR)/doctest/output.txt."
173
174 xml:
175 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
176 @echo
177 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
178
179 pseudoxml:
180 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
181 @echo
182 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
183
184 %.svg: %.mscgen
185 mscgen -T svg -o $@ $<
186
187 %.svg: %.dot
188 dot -T svg -o $@ $<
189
190 %.png: %.gpi common.gp
191 gnuplot -e "set term pngcairo size 640,480" $< > $@
192
193 ifeq ($(INKSCAPE_VER),0)
194 %.png: %.svg
195 inkscape --export-dpi 150 -e $@ $<
196
197 %.pdf: %.svg
198 inkscape -A $@ $<
199 else
200 %.png: %.svg
201 inkscape --export-dpi 150 --export-type png -o $@ $<
202
203 %.pdf: %.svg
204 inkscape --export-type pdf -o $@ $<
205 endif
206
207 %.pdf: %.gpi common.gp
208 gnuplot -e "set term pdfcairo size 10cm,7.5cm" $< > $@
209
210 %.pdf: %.mscgen
211 mscgen -T eps -o - $< | ps2pdf -dEPSCrop - $@
212
213 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext