diff options
author | Andrei Pavel <andrei@isc.org> | 2023-11-03 12:10:34 +0100 |
---|---|---|
committer | Andrei Pavel <andrei@isc.org> | 2023-11-06 11:10:51 +0100 |
commit | edabef7303d35b94fda91644945757492cc40b1e (patch) | |
tree | b9ca1593238de57188eb80ce7b2a3808f11e81a4 /doc/sphinx | |
parent | [#2969] update install section in ARM about docs (diff) | |
download | kea-edabef7303d35b94fda91644945757492cc40b1e.tar.xz kea-edabef7303d35b94fda91644945757492cc40b1e.zip |
[#2969] replace sphinx tabs with list-table
Diffstat (limited to 'doc/sphinx')
-rw-r--r-- | doc/sphinx/arm/install.rst | 5 | ||||
-rw-r--r-- | doc/sphinx/arm/quickstart.rst | 82 | ||||
-rw-r--r-- | doc/sphinx/conf.py | 1 | ||||
-rw-r--r-- | doc/sphinx/src/requirements.in | 1 | ||||
-rw-r--r-- | doc/sphinx/src/requirements.txt | 14 |
5 files changed, 51 insertions, 52 deletions
diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst index c43cc56b9e..48b08baed6 100644 --- a/doc/sphinx/arm/install.rst +++ b/doc/sphinx/arm/install.rst @@ -190,10 +190,9 @@ the system: 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. + ``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. + ``texlive``, and ``texlive-latex-extra`` are needed. If LaTeX packages are missing, Kea skips PDF generation and produces only HTML documents. diff --git a/doc/sphinx/arm/quickstart.rst b/doc/sphinx/arm/quickstart.rst index 24ce86841a..81cc316d51 100644 --- a/doc/sphinx/arm/quickstart.rst +++ b/doc/sphinx/arm/quickstart.rst @@ -76,11 +76,13 @@ easier to install Kea using native packages. Cloudsmith repository page under ``Packages``, or it can be retrieved using ``apk``/``apt``/``dnf``. -.. tabs:: +.. list-table:: + :stub-columns: 1 + :widths: 10 90 - .. tab:: Debian/Ubuntu + * - Debian/Ubuntu - .. code-block:: console + - .. code-block:: console $ apt search isc-kea @@ -89,83 +91,89 @@ easier to install Kea using native packages. transitional packages. The working server packages are ``isc-kea-dhcp4`` and ``isc-kea-dhcp6``. - .. tab:: Fedora/RedHat + * - Fedora/RedHat - .. code-block:: console + - .. code-block:: console $ dnf search 'isc-kea*' - .. tab:: Alpine + * - Alpine - .. code-block:: console + - .. code-block:: console $ apk search isc-kea 6. Install the metapackage containing all the tools, libraries, servers, documentation, and open source hooks: -.. tabs:: +.. list-table:: + :stub-columns: 1 + :widths: 10 90 - .. tab:: Debian/Ubuntu + * - Debian/Ubuntu - .. code-block:: console + - .. code-block:: console $ sudo apt install isc-kea - .. tab:: Fedora/RedHat + * - Fedora/RedHat - .. code-block:: console + - .. code-block:: console $ sudo dnf install isc-kea - .. tab:: Alpine + * - Alpine - .. code-block:: console + - .. code-block:: console # apk add isc-kea or specific packages: -.. tabs:: +.. list-table:: + :stub-columns: 1 + :widths: 10 90 - .. tab:: Debian/Ubuntu + * - Debian/Ubuntu - .. code-block:: console + - .. code-block:: console $ sudo apt install isc-kea-dhcp6 - .. tab:: Fedora/RedHat + * - Fedora/RedHat - .. code-block:: console + - .. code-block:: console $ sudo dnf install isc-kea-dhcp6 - .. tab:: Alpine + * - Alpine - .. code-block:: console + - .. code-block:: console $ apk add isc-kea-dhcp6 or every single Kea-related package, including development headers, debug symbols, and premium hooks (if available): -.. tabs:: +.. list-table:: + :stub-columns: 1 + :widths: 10 90 - .. tab:: Debian/Ubuntu + * - Debian/Ubuntu - .. code-block:: console + - .. code-block:: console $ sudo apt install 'isc-kea*' - .. tab:: Fedora/RedHat + * - Fedora/RedHat - .. code-block:: console + - .. code-block:: console $ sudo dnf install 'isc-kea*' - .. tab:: Alpine + * - Alpine - Installing packages via globbing (``*``) is not available for Alpine, + - Installing packages via globbing (``*``) is not available for Alpine, but it can be simulated with the following command: .. code-block:: console @@ -174,25 +182,25 @@ symbols, and premium hooks (if available): or all packages with a specified version number: -.. tabs:: +.. list-table:: + :stub-columns: 1 + :widths: 10 90 - .. tab:: Debian/Ubuntu + * - Debian/Ubuntu - .. code-block:: console + - .. code-block:: console $ sudo apt install 'isc-kea*=2.4.0-isc20230921141113' - .. tab:: Fedora/RedHat + * - Fedora/RedHat - .. code-block:: console + - .. code-block:: console $ sudo dnf install 'isc-kea*2.4.0-isc20230921141113*' - .. tab:: Alpine - - .. code-block:: console + * - Alpine - Installing packages via globbing (``*``) is not available for Alpine, + - Installing packages via globbing (``*``) is not available for Alpine, but it can be simulated with the following command: .. code-block:: console diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index af64d08be1..117d125cf3 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -59,7 +59,6 @@ dashed_version_series='-'.join(version.split('.')[0:2]) extensions = [ 'sphinx.ext.todo', 'sphinx.ext.mathjax', - 'sphinx_tabs.tabs', ] # The suffix(es) of source filenames. diff --git a/doc/sphinx/src/requirements.in b/doc/sphinx/src/requirements.in index fc5c91382c..cbf1e3658e 100644 --- a/doc/sphinx/src/requirements.in +++ b/doc/sphinx/src/requirements.in @@ -1,3 +1,2 @@ sphinx sphinx-rtd-theme -sphinx-tabs diff --git a/doc/sphinx/src/requirements.txt b/doc/sphinx/src/requirements.txt index 214d62d1ce..bc74c955be 100644 --- a/doc/sphinx/src/requirements.txt +++ b/doc/sphinx/src/requirements.txt @@ -6,17 +6,16 @@ # alabaster==0.7.13 # via sphinx -babel==2.13.0 +babel==2.13.1 # via sphinx certifi==2023.7.22 # via requests -charset-normalizer==3.3.0 +charset-normalizer==3.3.2 # via requests docutils==0.18.1 # via # sphinx # sphinx-rtd-theme - # sphinx-tabs idna==3.4 # via requests imagesize==1.4.1 @@ -28,9 +27,7 @@ markupsafe==2.1.3 packaging==23.2 # via sphinx pygments==2.16.1 - # via - # sphinx - # sphinx-tabs + # via sphinx requests==2.31.0 # via sphinx snowballstemmer==2.2.0 @@ -39,7 +36,6 @@ sphinx==7.2.6 # via # -r ./src/requirements.in # sphinx-rtd-theme - # sphinx-tabs # sphinxcontrib-applehelp # sphinxcontrib-devhelp # sphinxcontrib-htmlhelp @@ -48,8 +44,6 @@ sphinx==7.2.6 # sphinxcontrib-serializinghtml sphinx-rtd-theme==1.3.0 # via -r ./src/requirements.in -sphinx-tabs==3.4.1 - # via -r ./src/requirements.in sphinxcontrib-applehelp==1.0.7 # via sphinx sphinxcontrib-devhelp==1.0.5 @@ -64,5 +58,5 @@ sphinxcontrib-qthelp==1.0.6 # via sphinx sphinxcontrib-serializinghtml==1.1.9 # via sphinx -urllib3==2.0.6 +urllib3==2.0.7 # via requests |