Debian Codegraph @

docs/Makefile

raw
1 # Makefile for Sphinx documentation
2 #
3
4 # You can set these variables from the command line.
5 SPHINXOPTS = -W
6 SPHINXBUILD = sphinx-build
7 PAPER =
8 BUILDDIR = _build
9 PANDOC = pandoc
10
11 # User-friendly check for sphinx-build
12 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
13 $(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/)
14 endif
15
16 # Internal variables.
17 PAPEROPT_a4 = -D latex_paper_size=a4
18 PAPEROPT_letter = -D latex_paper_size=letter
19 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
20 # the i18n builder cannot share the environment and doctrees with the others
21 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
22
23 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext rst2md
24
25 help:
26 @echo "Please use \`make <target>' where <target> is one of"
27 @echo " html to make standalone HTML files"
28 @echo " dirhtml to make HTML files named index.html in directories"
29 @echo " singlehtml to make a single large HTML file"
30 @echo " pickle to make pickle files"
31 @echo " json to make JSON files"
32 @echo " htmlhelp to make HTML files and a HTML help project"
33 @echo " qthelp to make HTML files and a qthelp project"
34 @echo " devhelp to make HTML files and a Devhelp project"
35 @echo " epub to make an epub"
36 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37 @echo " latexpdf to make LaTeX files and run them through pdflatex"
38 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
39 @echo " text to make text files"
40 @echo " man to make manual pages"
41 @echo " texinfo to make Texinfo files"
42 @echo " info to make Texinfo files and run them through makeinfo"
43 @echo " gettext to make PO message catalogs"
44 @echo " changes to make an overview of all changed/added/deprecated items"
45 @echo " xml to make Docutils-native XML files"
46 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
47 @echo " linkcheck to check all external links for integrity"
48 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
49 @echo " rst2md to generate markdown files from rst files"
50
51 clean:
52 rm -rf $(BUILDDIR)/*
53
54 rst2md:
55 $(PANDOC) --wrap=none --from=rst --to=gfm --output=kip-848-migration-guide.md kip-848-migration-guide.rst
56 @echo
57 @echo "KIP-848 Migration Guide Markdown file generated: kip-848-migration-guide.md"
58
59 html:
60 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
61 @echo
62 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
63
64 dirhtml:
65 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
66 @echo
67 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
68
69 singlehtml:
70 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
71 @echo
72 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
73
74 pickle:
75 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
76 @echo
77 @echo "Build finished; now you can process the pickle files."
78
79 json:
80 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
81 @echo
82 @echo "Build finished; now you can process the JSON files."
83
84 htmlhelp:
85 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
86 @echo
87 @echo "Build finished; now you can run HTML Help Workshop with the" \
88 ".hhp project file in $(BUILDDIR)/htmlhelp."
89
90 qthelp:
91 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
92 @echo
93 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
94 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
95 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/confluent-kafka.qhcp"
96 @echo "To view the help file:"
97 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/confluent-kafka.qhc"
98
99 devhelp:
100 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
101 @echo
102 @echo "Build finished."
103 @echo "To view the help file:"
104 @echo "# mkdir -p $$HOME/.local/share/devhelp/confluent-kafka"
105 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/confluent-kafka"
106 @echo "# devhelp"
107
108 epub:
109 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
110 @echo
111 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
112
113 latex:
114 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115 @echo
116 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
117 @echo "Run \`make' in that directory to run these through (pdf)latex" \
118 "(use \`make latexpdf' here to do that automatically)."
119
120 latexpdf:
121 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
122 @echo "Running LaTeX files through pdflatex..."
123 $(MAKE) -C $(BUILDDIR)/latex all-pdf
124 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
125
126 latexpdfja:
127 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
128 @echo "Running LaTeX files through platex and dvipdfmx..."
129 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
130 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
131
132 text:
133 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
134 @echo
135 @echo "Build finished. The text files are in $(BUILDDIR)/text."
136
137 man:
138 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
139 @echo
140 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
141
142 texinfo:
143 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144 @echo
145 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
146 @echo "Run \`make' in that directory to run these through makeinfo" \
147 "(use \`make info' here to do that automatically)."
148
149 info:
150 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
151 @echo "Running Texinfo files through makeinfo..."
152 make -C $(BUILDDIR)/texinfo info
153 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
154
155 gettext:
156 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
157 @echo
158 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
159
160 changes:
161 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
162 @echo
163 @echo "The overview file is in $(BUILDDIR)/changes."
164
165 linkcheck:
166 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
167 @echo
168 @echo "Link check complete; look for any errors in the above output " \
169 "or in $(BUILDDIR)/linkcheck/output.txt."
170
171 doctest:
172 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
173 @echo "Testing of doctests in the sources finished, look at the " \
174 "results in $(BUILDDIR)/doctest/output.txt."
175
176 xml:
177 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
178 @echo
179 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
180
181 pseudoxml:
182 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
183 @echo
184 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."