]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: drop texinfo docs-develop-remo-nlx8qp/deployments/2715
authorOto Šťáva <oto.stava@nic.cz>
Fri, 15 Sep 2023 12:27:19 +0000 (14:27 +0200)
committerOto Šťáva <oto.stava@nic.cz>
Fri, 15 Sep 2023 12:27:19 +0000 (14:27 +0200)
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
doc/conf.py
doc/meson.build
scripts/make-doc.sh

index 718a0f17d99e9620a97fa6a3e94f47b0158d733d..5b3ca62492af7321e26bc16145baa796ecde7936 100644 (file)
@@ -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/
index 17640d31dac83309c16f8f80e9baa34dcab4b927..f7952a95eba0589f056a689f7a67ed1178031ab4 100644 (file)
@@ -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 = """
index b374571d10d5cfdeed3efca8935afaf50779def3..0dfa3cb3e8f5d8ca01d09927bf55cccaa440365c 100644 (file)
@@ -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
 
 
index 37078a082587ffa79e450bb2144ae8c7667a7dad..fda206d8dce6d2d7c27c0bcba400b20db00a47c4 100755 (executable)
@@ -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