knot-dns/doc/Makefile.am

174 lines
4.6 KiB
Makefile
Raw Permalink Normal View History

2017-03-22 12:08:08 -04:00
MANPAGES_RST = \
2023-01-19 03:31:58 -05:00
reference.rst \
2017-03-22 12:08:08 -04:00
man_knotc.rst \
man_knotd.rst \
2020-04-03 12:45:51 -04:00
man_kcatalogprint.rst \
2017-03-22 12:08:08 -04:00
man_keymgr.rst \
2018-03-21 05:24:35 -04:00
man_kjournalprint.rst \
2017-03-22 12:08:08 -04:00
man_kdig.rst \
man_khost.rst \
man_knsupdate.rst \
man_knsec3hash.rst \
2020-05-04 06:07:49 -04:00
man_kzonecheck.rst \
2020-08-05 13:17:40 -04:00
man_kzonesign.rst \
2020-08-04 12:45:05 -04:00
man_kxdpgun.rst
EXTRA_DIST = \
2017-03-22 12:08:08 -04:00
conf.py \
2015-04-16 03:11:44 -04:00
\
appendices.rst \
configuration.rst \
index.rst \
installation.rst \
introduction.rst \
migration.rst \
modules.rst.in \
2015-07-20 03:30:47 -04:00
operation.rst \
reference.rst \
requirements.rst \
2014-05-10 16:10:30 -04:00
troubleshooting.rst \
2015-04-16 03:11:44 -04:00
utilities.rst \
\
2015-05-24 14:21:59 -04:00
$(MANPAGES_RST) \
2014-05-10 16:10:30 -04:00
\
2019-09-28 11:19:59 -04:00
logo.pdf \
logo.svg \
\
ext/ignore_panels.py \
theme_epub \
theme_html
2015-05-07 03:57:41 -04:00
SPHINX_V = $(SPHINX_V_@AM_V@)
SPHINX_V_ = $(SPHINX_V_@AM_DEFAULT_V@)
SPHINX_V_0 = -q
SPHINX_V_1 = -n
2015-05-07 03:57:41 -04:00
AM_V_SPHINX = $(AM_V_SPHINX_@AM_V@)
AM_V_SPHINX_ = $(AM_V_SPHINX_@AM_DEFAULT_V@)
AM_V_SPHINX_0 = @echo " SPHINX $@";
2015-05-07 03:57:41 -04:00
2015-04-30 06:24:04 -04:00
SPHINXBUILDDIR = $(builddir)/_build
_SPHINXOPTS = -c $(srcdir) \
2015-05-07 03:57:41 -04:00
-a \
$(SPHINX_V) \
-D version="$(VERSION)" \
-D today="$(RELEASE_DATE)" \
-D release="$(VERSION)"
ALLSPHINXOPTS = $(_SPHINXOPTS) \
$(SPHINXOPTS) \
$(srcdir)
man_SPHINXOPTS = $(_SPHINXOPTS) \
-D extensions="ignore_panels" \
2015-05-07 03:57:41 -04:00
$(SPHINXOPTS) \
$(srcdir)
.PHONY: html-local singlehtml pdf-local epub man install-html-local install-singlehtml install-pdf-local install-epub
2016-05-09 02:45:50 -04:00
man_MANS =
if HAVE_DOCS
if HAVE_DAEMON
2017-03-22 12:08:08 -04:00
man_MANS += \
man/knot.conf.5 \
man/knotc.8 \
man/knotd.8
endif # HAVE_DAEMON
if HAVE_UTILS
2017-03-22 12:08:08 -04:00
if HAVE_DAEMON
man_MANS += \
2020-04-03 12:45:51 -04:00
man/kcatalogprint.8 \
2017-03-22 12:08:08 -04:00
man/keymgr.8 \
2018-03-21 05:24:35 -04:00
man/kjournalprint.8 \
2020-08-05 13:17:40 -04:00
man/kzonecheck.1 \
man/kzonesign.1
2017-03-22 12:08:08 -04:00
endif # HAVE_DAEMON
man_MANS += \
man/kdig.1 \
man/khost.1 \
man/knsupdate.1 \
man/knsec3hash.1
2020-05-04 06:07:49 -04:00
if ENABLE_XDP
2020-08-04 12:45:05 -04:00
man_MANS += man/kxdpgun.8
2020-05-04 06:07:49 -04:00
endif # ENABLE_XDP
endif # HAVE_UTILS
if HAVE_SPHINX
html-local:
$(AM_V_SPHINX)$(SPHINXBUILD) -b html -d $(SPHINXBUILDDIR)/doctrees/html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html
2023-01-19 03:31:58 -05:00
@echo "The HTML documentation has been built in $(SPHINXBUILDDIR)/html/"
install-html-local:
$(INSTALL) -d $(DESTDIR)/$(docdir) $(DESTDIR)/$(docdir)/_static $(DESTDIR)/$(docdir)/_sources
$(INSTALL) -D $(SPHINXBUILDDIR)/html/*.html $(DESTDIR)/$(docdir)/
$(INSTALL_DATA) $(SPHINXBUILDDIR)/html/_sources/* $(DESTDIR)/$(docdir)/_sources/
$(INSTALL_DATA) $(SPHINXBUILDDIR)/html/_static/* $(DESTDIR)/$(docdir)/_static/
singlehtml:
$(AM_V_SPHINX)$(SPHINXBUILD) -b singlehtml -d $(SPHINXBUILDDIR)/doctrees/singlehtml $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/singlehtml
2023-01-19 03:31:58 -05:00
@echo "The single HTML documentation has been built in $(SPHINXBUILDDIR)/singlehtml/"
install-singlehtml: singlehtml
$(INSTALL) -d $(DESTDIR)/$(docdir) $(DESTDIR)/$(docdir)/_static
$(INSTALL_DATA) $(SPHINXBUILDDIR)/singlehtml/*.html $(DESTDIR)/$(docdir)/
$(INSTALL_DATA) $(SPHINXBUILDDIR)/singlehtml/_static/* $(DESTDIR)/$(docdir)/_static/
2020-01-24 08:37:24 -05:00
epub:
$(AM_V_SPHINX)$(SPHINXBUILD) -b epub -A today=$(RELEASE_DATE) -d $(SPHINXBUILDDIR)/doctrees/epub $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/epub
2023-01-19 03:31:58 -05:00
@echo "The EPUB documentation has been built in $(SPHINXBUILDDIR)/epub/"
2020-01-24 08:37:24 -05:00
install-epub:
$(INSTALL) -d $(DESTDIR)/$(docdir)
$(INSTALL_DATA) $(SPHINXBUILDDIR)/epub/KnotDNS.epub $(DESTDIR)/$(docdir)/
if HAVE_PDFLATEX
pdf-local:
$(AM_V_SPHINX)$(SPHINXBUILD) -b latex -d $(SPHINXBUILDDIR)/doctrees/latex $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/latex
$(MAKE) -C $(SPHINXBUILDDIR)/latex all-pdf
2023-01-19 03:31:58 -05:00
@echo "The PDF documentation has been built in $(SPHINXBUILDDIR)/latex/"
install-pdf-local:
$(INSTALL) -d $(DESTDIR)/$(docdir)
2018-11-19 03:50:59 -05:00
$(INSTALL_DATA) $(SPHINXBUILDDIR)/latex/KnotDNS.pdf $(DESTDIR)/$(docdir)/
else
pdf-local install-pdf-local:
2023-01-19 03:31:58 -05:00
@echo "Install 'pdflatex' and re-run configure to be able to generate PDF documentation!"
endif # HAVE_PDFLATEX
man: $(man_MANS)
$(man_MANS)&: $(MANPAGES_RST)
$(AM_V_SPHINX)$(SPHINXBUILD) -b man -d $(SPHINXBUILDDIR)/doctrees/man $(man_SPHINXOPTS) $(SPHINXBUILDDIR)/man
@mkdir -p man
2018-02-11 09:09:32 -05:00
@for f in $(SPHINXBUILDDIR)/man/*; do \
sed -e 's,[@]config_dir@,$(config_dir),' \
-e 's,[@]storage_dir@,$(storage_dir),' \
-e 's,[@]run_dir@,$(run_dir),' \
-e 's,[@]conf_mapsize@,$(conf_mapsize),' "$$f" > "man/$$(basename $$f)"; \
done
else
html-local singlehtml pdf-local epub man install-html-local install-singlehtml install-pdf-local install-epub:
2023-01-19 03:31:58 -05:00
@echo "Install 'sphinx-build' and re-run configure to be able to generate documentation!"
2014-05-07 08:35:23 -04:00
$(man_MANS)&:
@if [ ! -f "$@" ]; then \
echo "Install 'sphinx-build' or disable documentation and re-run configure to generate man pages!"; \
fi
endif # HAVE_SPHINX
endif # HAVE_DOCS
EXTRA_DIST += \
$(man_MANS)
2014-05-07 08:35:23 -04:00
clean-local:
2015-04-30 06:24:04 -04:00
-rm -rf $(SPHINXBUILDDIR)
-rm -rf man