blob: 7fa957bdcd64d2a9a3a97ff9c7440a15f607f840 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
EXTRA_DIST =
sphinxbuilddir = $(builddir)/_build
abs_sphinxbuilddir = $(abs_builddir)/_build
if GENERATE_DOCS
sphinxopts =
sphinxopts += -v
sphinxopts += -E
sphinxopts += -a
sphinxopts += -W
sphinxopts += -j 2
sphinxopts += -c "${abs_srcdir}"
static_sources =
static_sources += static/kea-imageonly-100bw.png
static_sources += static/kea-logo-100x70.png
static_sources += static/kea-logo-200.png
static_sources += static/kea.css
# ARM
rst_arm_sources =
rst_arm_sources += index.rst
rst_arm_sources += manpages.rst
rst_arm_sources += umls.rst
include arm/rst_arm_sources.mk
EXTRA_DIST += arm/rst_arm_sources.mk
main_sources = $(rst_arm_sources) conf.py $(static_sources)
# mans
rst_man_sources =
include man/rst_man_sources.mk
EXTRA_DIST += man/rst_man_sources.mk
rst_arm_sources += grammar/grammar.rst
rst_arm_sources += grammar/grammar-ca-parser.rst
rst_arm_sources += grammar/grammar-d2-parser.rst
rst_arm_sources += grammar/grammar-dhcp4-parser.rst
rst_arm_sources += grammar/grammar-dhcp6-parser.rst
rst_arm_sources += grammar/grammar-netconf-parser.rst
man8s =
include man/man8s.mk
EXTRA_DIST += man/man8s.mk
man_sources = $(rst_man_sources) conf.py
EXTRA_DIST += $(main_sources) $(man_sources) mes2doc.py api2doc.py $(man8s)
# list of messages files that are used to generate kea-messages.rst and then kea-messages.pdf
mes_files =
include $(srcdir)/mes_files.mk
EXTRA_DIST += mes_files.mk
# list of api files that are used to generate api.rst
api_files =
include $(top_srcdir)/src/share/api/api_files.mk
if HAVE_PDFLATEX
all: html mans pdf text
else
all: html mans text
endif
# build the list of message files
mes-files.txt: mes_files.mk
@sed 's;mes_files .*)/;;' $< > $@
# this rule is only used for development purposes and is not used in official
# build process as kea-messages.rst is always generated via sphinx's conf.py
$(srcdir)/kea-messages.rst: $(mes_files) mes2doc.py
$(PYTHON) $(srcdir)/mes2doc.py -o $@ $(mes_files)
# build the list of api files
api-files.txt: $(top_srcdir)/src/share/api/api_files.mk
@sed 's;api_files .*)/;;' $< > $@
# some tools do not use this makefile but still need generate files.
EXTRA_DIST += mes-files.txt api-files.txt
# this rule is only used for development purposes and is not used in official
# build process as api.rst is always generated via sphinx's conf.py
$(srcdir)/api.rst: $(api_files) api-files.txt api2doc.py
$(PYTHON) $(srcdir)/api2doc.py -o $@ $(api_files)
$(srcdir)/arm/platforms.rst:
rm -f $(srcdir)/arm/platforms.rst
cp $(srcdir)/../../platforms.rst $(srcdir)/arm/platforms.rst
# UML files
if HAVE_PLANTUML
.uml.png:
@PLANTUML@ $<
.uml.svg:
@PLANTUML@ -svg $<
endif
EXTRA_DIST += uml/appendRequestedOptions.png
EXTRA_DIST += uml/appendRequestedOptions.svg
EXTRA_DIST += uml/appendRequestedOptions.uml
EXTRA_DIST += uml/appendRequestedVendorOptions.png
EXTRA_DIST += uml/appendRequestedVendorOptions.svg
EXTRA_DIST += uml/appendRequestedVendorOptions.uml
EXTRA_DIST += uml/assign-lease4.png
EXTRA_DIST += uml/assign-lease4.svg
EXTRA_DIST += uml/assign-lease4.uml
EXTRA_DIST += uml/buildCfgOptionList.png
EXTRA_DIST += uml/buildCfgOptionList.svg
EXTRA_DIST += uml/buildCfgOptionList.uml
EXTRA_DIST += uml/currentHost4.png
EXTRA_DIST += uml/currentHost4.svg
EXTRA_DIST += uml/currentHost4.uml
EXTRA_DIST += uml/lease-states.png
EXTRA_DIST += uml/lease-states.svg
EXTRA_DIST += uml/lease-states.uml
EXTRA_DIST += uml/main-loop.png
EXTRA_DIST += uml/main-loop.svg
EXTRA_DIST += uml/main-loop.uml
EXTRA_DIST += uml/packet4.png
EXTRA_DIST += uml/packet4.svg
EXTRA_DIST += uml/packet4.uml
EXTRA_DIST += uml/request4-lease.png
EXTRA_DIST += uml/request4-lease.svg
EXTRA_DIST += uml/request4-lease.uml
EXTRA_DIST += uml/request4.png
EXTRA_DIST += uml/request4.svg
EXTRA_DIST += uml/request4.uml
EXTRA_DIST += uml/requestLease4.png
EXTRA_DIST += uml/requestLease4.svg
EXTRA_DIST += uml/requestLease4.uml
EXTRA_DIST += uml/select4.png
EXTRA_DIST += uml/select4.svg
EXTRA_DIST += uml/select4.uml
EXTRA_DIST += uml/tkey.png
EXTRA_DIST += uml/tkey.svg
EXTRA_DIST += uml/tkey.uml
EXTRA_DIST += uml/update.png
EXTRA_DIST += uml/update.svg
EXTRA_DIST += uml/update.uml
PDFLATEX_AND_OPTS=$(PDFLATEX) -interaction nonstopmode
pdf: $(main_sources) api-files.txt mes-files.txt $(srcdir)/arm/platforms.rst
$(SPHINXBUILD) -M latex $(srcdir) $(sphinxbuilddir) $(sphinxopts)
-cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-arm.tex
-cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-arm.tex
-cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-arm.tex
-cd $(abs_sphinxbuilddir)/latex && makeindex -s python.ist kea-arm.idx
-cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-arm.tex
cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-arm.tex
-cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-messages.tex
-cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-messages.tex
-cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-messages.tex
-cd $(abs_sphinxbuilddir)/latex && makeindex -s python.ist kea-messages.idx
-cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-messages.tex
cd $(abs_sphinxbuilddir)/latex && $(PDFLATEX_AND_OPTS) kea-messages.tex
html: $(main_sources) api-files.txt mes-files.txt $(srcdir)/arm/platforms.rst
$(SPHINXBUILD) -M html $(srcdir) $(sphinxbuilddir) $(sphinxopts)
# This target is not used anywhere, but people who prefer single page docs
# can do make -C doc/sphinx singlehtml and then enjoy their docs being
# generated in doc/sphinx/_build/singlehtml
singlehtml: $(main_sources) api-files.txt mes-files.txt $(srcdir)/arm/platforms.rst
$(SPHINXBUILD) -M singlehtml $(srcdir) $(sphinxbuilddir) $(sphinxopts)
text: $(main_sources) api-files.txt mes-files.txt $(srcdir)/arm/platforms.rst
$(SPHINXBUILD) -M text $(srcdir) $(sphinxbuilddir) $(sphinxopts)
$(man8s): mans
mans: $(man_sources) api-files.txt mes-files.txt
$(SPHINXBUILD) -M man $(srcdir) $(sphinxbuilddir) $(sphinxopts)
# Updates sphinx dependencies to the latest versions available on the current
# host and freezes them in ./src/requirements.txt. Requires pip-compile:
# pip install pip-tools
# Run this when dependencies are added, changed or removed.
update-python-dependencies: ./src/requirements.in
pip-compile -r ./src/requirements.in
clean-local:
rm -rf $(sphinxbuilddir)
rm -f $(srcdir)/mes-files.txt $(srcdir)/api-files.txt
rm -f $(srcdir)/kea-messages.rst $(srcdir)/api.rst
rm -f $(srcdir)/arm/platforms.rst
.PHONY: all pdf html mans
endif
# install and uninstall can occur with GENERATE_DOCS and without it
# so we want to install all when GENERATE_DOCS is and
# just mans when GENERATE_DOCS is not used, and when man files exists (e.g release tarball)
install-data-local:
mkdir -p $(DESTDIR)$(docdir)
if GENERATE_DOCS
cp -r $(sphinxbuilddir)/html $(DESTDIR)$(docdir)
if HAVE_PDFLATEX
${INSTALL_DATA} $(sphinxbuilddir)/latex/kea-arm.pdf $(DESTDIR)$(docdir)
${INSTALL_DATA} $(sphinxbuilddir)/latex/kea-messages.pdf $(DESTDIR)$(docdir)
endif
${MKDIR_P} ${DESTDIR}${mandir}/man8
${INSTALL_DATA} $(man8s) ${DESTDIR}${mandir}/man8/
else
if INSTALL_MANS
${MKDIR_P} ${DESTDIR}${mandir}/man8
${INSTALL_DATA} $(sphinxbuilddir)/man/*.8 ${DESTDIR}${mandir}/man8/
endif
endif
uninstall-local:
rm -rf $(DESTDIR)$(docdir)
# There are sometimes conflicts when more then one sphinx-build is run at a time.
# This target blocks running anything in parallel in this Makefile,
# all is run serially.
.NOTPARALLEL:
|
