From: Michal Nowikowski Date: Sat, 20 Jul 2019 07:12:42 +0000 (+0200) Subject: improved building docs on some systems X-Git-Tag: Kea-1.6.1~10^2~39 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=66e300f74fc004f60a8ed3ebdaf31bb60a915a78;p=thirdparty%2Fkea.git improved building docs on some systems - improved handling sphinx in configure.ac - adjusted hammer with new deps for docs - updated docs about new deps for docs --- diff --git a/configure.ac b/configure.ac index 8d443ed5c1..c4067fe08e 100644 --- a/configure.ac +++ b/configure.ac @@ -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 diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst index 6558710838..9c8b8ccf9f 100644 --- a/doc/sphinx/arm/install.rst +++ b/doc/sphinx/arm/install.rst @@ -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 `_, + 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. diff --git a/hammer.py b/hammer.py index d2560466e4..739c44bbeb 100755 --- 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()