From afd143f6e72471824346c4fe4f544959958fd1b0 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Oto=20=C5=A0=C5=A5=C3=A1va?= Date: Fri, 15 Sep 2023 14:27:19 +0200 Subject: [PATCH] doc: drop texinfo Old legacy. The generated .texi sources cause a huge number of warnings that we do not have a good way of fixing, and lately it stopped working completely, without giving us any explanation as to what the problem is (just exit code 1 and no *error* message). --- doc/build.rst | 3 --- doc/conf.py | 10 ---------- doc/meson.build | 9 --------- scripts/make-doc.sh | 25 ------------------------- 4 files changed, 47 deletions(-) diff --git a/doc/build.rst b/doc/build.rst index 718a0f17d..5b3ca6249 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -123,8 +123,6 @@ Resolver: "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_." @@ -329,7 +327,6 @@ For development, it's possible to build the container directly from your git tre .. _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/ diff --git a/doc/conf.py b/doc/conf.py index 17640d31d..f7952a95e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -89,16 +89,6 @@ man_pages = [ [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 = """ diff --git a/doc/meson.build b/doc/meson.build index b374571d1..0dfa3cb3e 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -33,7 +33,6 @@ if get_option('doc') == 'enabled' 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) @@ -70,14 +69,6 @@ if get_option('doc') == 'enabled' 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 diff --git a/scripts/make-doc.sh b/scripts/make-doc.sh index 37078a082..fda206d8d 100755 --- a/scripts/make-doc.sh +++ b/scripts/make-doc.sh @@ -23,28 +23,3 @@ set -o errexit -o nounset 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 -- 2.47.2