summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrei Pavel <andrei@isc.org>2023-10-25 13:15:05 +0200
committerAndrei Pavel <andrei@isc.org>2023-10-26 15:34:22 +0200
commitff6822a8c129292dbec193748d0a9fd543b4def1 (patch)
tree64e6d4170341b8df8509e8ae268191cd90c2356f
parent[#2969] add sphinx-tabs to fedora, freebsd, alpine (diff)
downloadkea-ff6822a8c129292dbec193748d0a9fd543b4def1.tar.xz
kea-ff6822a8c129292dbec193748d0a9fd543b4def1.zip
[#2969] update install section in ARM about docs
-rw-r--r--doc/sphinx/arm/install.rst15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst
index 50d5189512..c43cc56b9e 100644
--- a/doc/sphinx/arm/install.rst
+++ b/doc/sphinx/arm/install.rst
@@ -187,12 +187,15 @@ the system:
configuration option to build the unit tests.
- 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. Specifically,
- with Fedora, python3-sphinx, texlive, and texlive-collection-latexextra are necessary;
- with Ubuntu, python3-sphinx, python3-sphinx-rtd-theme, and texlive-binaries
- are needed. If LaTeX packages are missing, Kea skips PDF generation and produces
- only HTML documents.
+ texlive with its extensions, and Doxygen, if using the
+ ``--enable-generate-docs`` configuration option to create the documentation.
+ Specifically, with Fedora, ``python3-sphinx``, ``python3-sphinx_rtd_theme``,
+ ``python3-sphinx-tabs``, ``texlive``, and ``texlive-collection-latexextra``
+ are necessary.
+ With Ubuntu, ``python3-sphinx``, ``python3-sphinx-rtd-theme``,
+ ``python3-sphinx-tabs``, ``texlive``, and ``texlive-latex-extra`` are needed.
+ If LaTeX packages are missing, Kea skips PDF generation and produces only
+ HTML documents.
Visit ISC's Knowledgebase at https://kb.isc.org/docs/installing-kea for
system-specific installation tips.