]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
improved building docs on some systems
authorMichal Nowikowski <godfryd@isc.org>
Sat, 20 Jul 2019 07:12:42 +0000 (09:12 +0200)
committerMichal Nowikowski <godfryd@isc.org>
Tue, 30 Jul 2019 08:45:13 +0000 (10:45 +0200)
- improved handling sphinx in configure.ac
- adjusted hammer with new deps for docs
- updated docs about new deps for docs

configure.ac
doc/sphinx/arm/install.rst
hammer.py

index 8d443ed5c1a06a029d4d39c0995d72d243a9f9a0..c4067fe08ef8dfba8742ba27d2172bb9c8385903 100644 (file)
@@ -1438,9 +1438,19 @@ AC_ARG_ENABLE(generate_docs, [AC_HELP_STRING([--enable-generate-docs],
   [regenerate documentation using Sphinx [default=no]])],
   enable_generate_docs=$enableval, enable_generate_docs=no)
 
+AC_ARG_WITH([sphinx],
+  AC_HELP_STRING([--with-sphinx=PATH], [path to sphinx-build tool]),
+  [sphinx_path="$withval"])
+
 if test "x$enable_generate_docs" != xno ; then
+
 # Check for sphinx-build
-  AC_PATH_PROG([SPHINXBUILD], [sphinx-build])
+  if test -z "$sphinx_path"; then
+     AC_PATH_PROGS([SPHINXBUILD], [sphinx-build sphinx-build-3])
+  else
+     SPHINXBUILD="$sphinx_path"
+  fi
+  echo $SPHINXBUILD
   if test -z "$SPHINXBUILD"; then
     AC_MSG_ERROR([sphinx-build not found; it is required for --enable-generate-docs, please see http://www.sphinx-doc.org/en/master/usage/installation.html for details])
   else
index 6558710838374e261860ebaffaf1a7b4a6ba3d9d..9c8b8ccf9f3f6c3890b2129f6e9946097b432211 100644 (file)
@@ -112,9 +112,9 @@ the system:
 -  googletest (version 1.8 or later) is required when using the --with-gtest
    configuration option to build the unit tests.
 
--  The documentation generation tools elinks, docbook-xsl, libxslt, and
-   Doxygen, if using the --enable-generate-docs configuration option to
-   create the documentation.
+-  The documentation generation tools `Sphinx <https://www.sphinx-doc.org/>`_,
+   texlive with its extensions and Doxygen, if using the --enable-generate-docs
+   configuration option to create the documentation.
 
 Visit ISC's Knowledgebase at https://kb.isc.org/docs/installing-kea for
 system-specific installation tips.
index d2560466e4cdfb871efa76fcf4a0484f85852643..739c44bbeb93342ada1ceb6b2a6bed4967f3602d 100755 (executable)
--- a/hammer.py
+++ b/hammer.py
@@ -1021,7 +1021,9 @@ def prepare_system_local(features, check_times):
             packages.extend(['rpm-build', 'python2-devel', 'python3-devel'])
 
         if 'docs' in features:
-            packages.extend(['libxslt', 'elinks', 'docbook-style-xsl'])
+            packages.extend(['python3-sphinx', 'texlive', 'texlive-fncychap', 'texlive-tabulary',
+                             'texlive-framed', 'texlive-wrapfig', 'texlive-upquote',
+                             'texlive-capt-of', 'texlive-needspace', 'latexmk'])
 
         if 'mysql' in features:
             execute('sudo dnf remove -y community-mysql-devel || true')
@@ -1187,7 +1189,9 @@ def prepare_system_local(features, check_times):
                 packages.append('googletest')
 
         if 'docs' in features:
-            packages.extend(['dblatex', 'xsltproc', 'elinks', 'docbook-xsl'])
+            packages.extend(['python3-sphinx', 'python3-sphinx-rtd-theme', 'latexmk'])
+            if revision == '9':
+                packages.append('texlive-generic-extra')
 
         if 'native-pkg' in features:
             packages.extend(['build-essential', 'fakeroot', 'devscripts'])
@@ -1223,7 +1227,7 @@ def prepare_system_local(features, check_times):
         packages = ['autoconf', 'automake', 'libtool', 'openssl', 'log4cplus', 'boost-libs']
 
         if 'docs' in features:
-            packages.extend(['libxslt', 'elinks', 'docbook-xsl'])
+            packages.extend(['py36-sphinx', 'py36-sphinx_rtd_theme'])
 
         if 'unittest' in features:
             _install_gtest_sources()