bind9/doc/arm/Makefile.am
Petr Špaček a23fa7edc9 Add Sphinx extension to help with ARM maintenance and cross-linking
The extension provides a "Sphinx domain factory". Each new Sphinx domain
defines a namespace for configuration statements so named.conf and
rndc.conf do not clash. Currently the Sphinx domains are instantiated
twice and resuling domains are named "namedconf" and "rndcconf".

This commit adds a single new directive:

.. statement:: max-cache-size

It is namespaced like this:

.. namedconf:statement:: max-cache-size

This directive generates a new anchor for configuration statement and it
can be referenced like :any:`max-cache-size` (if the identifier is
unique), or more specific :namedconf:ref:`max-cache-size`.

It is based on Sphinx "tutorial" extension "recipe".
Beware, some details in Sphinx docs are not up-to-date, it's better
to read Sphinx and docutil sources.
2022-06-09 14:44:29 +02:00

128 lines
3.5 KiB
Makefile

include $(top_srcdir)/Makefile.top
include $(top_srcdir)/Makefile.docs
EXTRA_DIST = \
advanced.inc.rst \
build.inc.rst \
catz.inc.rst \
chapter10.rst \
chapter1.rst \
chapter2.rst \
chapter3.rst \
chapter4.rst \
chapter5.rst \
chapter6.rst \
chapter7.rst \
chapter9.rst \
config-auth.inc.rst \
config-intro.inc.rst \
config-resolve.inc.rst \
conf.py \
dlz.inc.rst \
dns-ops.inc.rst \
dnssec-guide.rst \
dnssec.inc.rst \
dns-security-overview.dia \
dns-security-overview.png \
dns-servers.dia \
dns-servers.png \
dns-tree.dia \
dns-tree.png \
dyndb.inc.rst \
general.rst \
history.rst \
index.rst \
intro-dns-bind.inc.rst \
introduction.inc.rst \
intro-security.inc.rst \
isc-logo.pdf \
logging-categories.inc.rst \
managed-keys.inc.rst \
manpages.rst \
name-resolution.dia \
name-resolution.png \
notes.rst \
pkcs11.inc.rst \
platforms.inc.rst \
plugins.inc.rst \
primary-secondary.dia \
primary-secondary.png \
recursive-query.dia \
recursive-query.png \
reference.rst \
requirements.inc.rst \
requirements.txt \
resolver-forward.dia \
resolver-forward.png \
rpz.inc.rst \
security.inc.rst \
sig0.inc.rst \
tkey.inc.rst \
troubleshooting.inc.rst \
tsig.inc.rst \
zones.inc.rst \
_ext/iscconf.py \
_ext/namedconf.py \
_ext/rndcconf.py \
_static/custom.css \
../dnssec-guide \
../misc/acl.grammar.rst \
../misc/controls.grammar.rst \
../misc/delegation-only.zoneopt.rst \
../misc/forward.zoneopt.rst \
../misc/hint.zoneopt.rst \
../misc/in-view.zoneopt.rst \
../misc/key.grammar.rst \
../misc/logging.grammar.rst \
../misc/managed-keys.grammar.rst \
../misc/primary.zoneopt.rst \
../misc/mirror.zoneopt.rst \
../misc/options.grammar.rst \
../misc/parental-agents.grammar.rst \
../misc/primaries.grammar.rst \
../misc/redirect.zoneopt.rst \
../misc/server.grammar.rst \
../misc/secondary.zoneopt.rst \
../misc/static-stub.zoneopt.rst \
../misc/statistics-channels.grammar.rst \
../misc/stub.zoneopt.rst \
../misc/trusted-keys.grammar.rst \
../notes/*.rst
html-local:
$(AM_V_SPHINX)$(SPHINX_BUILD) -b html -d $(SPHINXBUILDDIR)/.doctrees/html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html
install-html-local:
$(INSTALL) -d $(DESTDIR)/$(docdir) $(DESTDIR)/$(docdir)/_static
$(INSTALL) -D $(SPHINXBUILDDIR)/html/*.html $(DESTDIR)/$(docdir)/
cp -R $(SPHINXBUILDDIR)/html/_static/ $(DESTDIR)/$(docdir)/_static/
singlehtml:
$(AM_V_SPHINX)$(SPHINX_BUILD) -b singlehtml -d $(SPHINXBUILDDIR)/.doctrees/singlehtml $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/singlehtml
install-singlehtml: singlehtml
$(INSTALL) -d $(DESTDIR)/$(docdir) $(DESTDIR)/$(docdir)/_static
$(INSTALL_DATA) $(SPHINXBUILDDIR)/singlehtml/*.html $(DESTDIR)/$(docdir)/
cp -R $(SPHINXBUILDDIR)/singlehtml/_static/* $(DESTDIR)/$(docdir)/_static/
epub:
$(AM_V_SPHINX)$(SPHINX_BUILD) -b epub -d $(SPHINXBUILDDIR)/.doctrees/epub $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/epub
install-epub:
$(INSTALL) -d $(DESTDIR)/$(docdir)
$(INSTALL_DATA) $(SPHINXBUILDDIR)/epub/*.epub $(DESTDIR)/$(docdir)/
if HAVE_XELATEX
pdf-local:
$(AM_V_SPHINX)$(SPHINX_BUILD) -b latex -d $(SPHINXBUILDDIR)/.doctrees/latex $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/latex
$(MAKE) -C $(SPHINXBUILDDIR)/latex all-pdf
install-pdf-local:
$(INSTALL) -d $(DESTDIR)/$(docdir)
$(INSTALL_DATA) $(SPHINXBUILDDIR)/latex/*.pdf $(DESTDIR)/$(docdir)/
endif
clean-local:
-rm -rf $(SPHINXBUILDDIR)
doc-local: html singlehtml pdf epub