"Doxygen_", "``documentation``", "Generating API documentation."
"Sphinx_, sphinx-tabs_ and sphinx_rtd_theme_", "``documentation``", "Building this
documentation."
- "Texinfo_", "``documentation``", "Generating this documentation in Info
- format."
"breathe_", "``documentation``", "Exposing Doxygen API doc to Sphinx."
"libprotobuf_ 3.0+", "``modules/dnstap``", "Protocol Buffers support for
dnstap_."
.. _Sphinx: http://sphinx-doc.org/
.. _sphinx-tabs: https://sphinx-tabs.readthedocs.io
.. _sphinx_rtd_theme: https://pypi.python.org/pypi/sphinx_rtd_theme
-.. _Texinfo: https://www.gnu.org/software/texinfo/
.. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config/
.. _libknot: https://gitlab.nic.cz/knot/knot-dns
.. _cmocka: https://cmocka.org/
[u'CZ.NIC Labs'], 1)
]
-# -- Options for Texinfo output ------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', 'knot-resolver', u'Knot Resolver', u'CZ.NIC Labs',
- 'Knot Resolver', 'Caching DNS resolver.', 'Network services'),
-]
-
# reStructuredText that will be included at the beginning of every source file that is read.
# This is a possible place to add substitutions that should be available in every file.
rst_prolog = """
if not sphinx_build.found()
sphinx_build = find_program('sphinx-build')
endif
- makeinfo = find_program('makeinfo', required: false)
# python dependencies: breathe, sphinx_rtd_theme
python_breathe = run_command('python3', '-c', 'import breathe', check: false)
install_dir: doc_dir,
)
- if makeinfo.found()
- # install info docs
- install_subdir(
- meson.current_source_dir() / 'texinfo' / '.install',
- strip_directory: true,
- install_dir: info_dir,
- )
- endif
endif
rm -rf doc/html
${SPHINX} ${@} -b html -d doc/.doctrees doc doc/html
-
-if command -v makeinfo &>/dev/null; then
- rm -rf doc/texinfo
- ${SPHINX} ${@} -b texinfo -d doc/.doctrees doc doc/texinfo
-
- # Sphinx < 2 doesn't create a separate directory for figures, so if
- # necessary move them to the correct location and update the references in
- # the generated Texinfo file
- if [ ! -d doc/texinfo/knot-resolver-figures ]; then
- cd doc/texinfo
- mkdir knot-resolver-figures
- mv *.png *.svg knot-resolver-figures/
- sed -e 's/\(@image{\)/\1knot-resolver-figures\//' \
- knot-resolver.texi > knot-resolver.texi.tmp
- mv knot-resolver.texi.tmp knot-resolver.texi
- cd ../..
- fi
-
- make -C doc/texinfo info
-
- mkdir doc/texinfo/.install
- mv doc/texinfo/knot-resolver.info \
- doc/texinfo/knot-resolver-figures \
- doc/texinfo/.install/
-fi