mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-28 12:37:55 +00:00
Code Issues Releases Wiki Activity

[#2969] replace sphinx tabs with list-table

Browse Source
This commit is contained in:
Andrei Pavel 2023-11-03 13:10:34 +02:00
parent ff6822a8c1
commit edabef7303
No known key found for this signature in database
GPG Key ID: D4E804481939CB21
5 changed files with 51 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/sphinx/arm/install.rst
View File

@ -190,10 +190,9 @@ the system:
texlive with its extensions, and Doxygen, if using the texlive with its extensions, and Doxygen, if using the
``--enable-generate-docs`` configuration option to create the documentation. ``--enable-generate-docs`` configuration option to create the documentation.
Specifically, with Fedora, ``python3-sphinx``, ``python3-sphinx_rtd_theme``, Specifically, with Fedora, ``python3-sphinx``, ``python3-sphinx_rtd_theme``,
``python3-sphinx-tabs``, ``texlive``, and ``texlive-collection-latexextra`` ``texlive``, and ``texlive-collection-latexextra`` are necessary.
are necessary.
With Ubuntu, ``python3-sphinx``, ``python3-sphinx-rtd-theme``, 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 If LaTeX packages are missing, Kea skips PDF generation and produces only
HTML documents. HTML documents.

82
doc/sphinx/arm/quickstart.rst
View File

@ -76,11 +76,13 @@ easier to install Kea using native packages.
Cloudsmith repository page under ``Packages``, or it can be retrieved Cloudsmith repository page under ``Packages``, or it can be retrieved
using ``apk``/``apt``/``dnf``. 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 $ apt search isc-kea
@ -89,83 +91,89 @@ easier to install Kea using native packages.
transitional packages. The working server packages are transitional packages. The working server packages are
``isc-kea-dhcp4`` and ``isc-kea-dhcp6``. ``isc-kea-dhcp4`` and ``isc-kea-dhcp6``.
.. tab:: Fedora/RedHat * - Fedora/RedHat
.. code-block:: console - .. code-block:: console
$ dnf search 'isc-kea*' $ dnf search 'isc-kea*'
.. tab:: Alpine * - Alpine
.. code-block:: console - .. code-block:: console
$ apk search isc-kea $ apk search isc-kea
6. Install the metapackage containing all the tools, libraries, servers, 6. Install the metapackage containing all the tools, libraries, servers,
documentation, and open source hooks: 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 $ sudo apt install isc-kea
.. tab:: Fedora/RedHat * - Fedora/RedHat
.. code-block:: console - .. code-block:: console
$ sudo dnf install isc-kea $ sudo dnf install isc-kea
.. tab:: Alpine * - Alpine
.. code-block:: console - .. code-block:: console
# apk add isc-kea # apk add isc-kea
or specific packages: 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 $ sudo apt install isc-kea-dhcp6
.. tab:: Fedora/RedHat * - Fedora/RedHat
.. code-block:: console - .. code-block:: console
$ sudo dnf install isc-kea-dhcp6 $ sudo dnf install isc-kea-dhcp6
.. tab:: Alpine * - Alpine
.. code-block:: console - .. code-block:: console
$ apk add isc-kea-dhcp6 $ apk add isc-kea-dhcp6
or every single Kea-related package, including development headers, debug or every single Kea-related package, including development headers, debug
symbols, and premium hooks (if available): 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*' $ sudo apt install 'isc-kea*'
.. tab:: Fedora/RedHat * - Fedora/RedHat
.. code-block:: console - .. code-block:: console
$ sudo dnf install 'isc-kea*' $ 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: but it can be simulated with the following command:
.. code-block:: console .. code-block:: console
@ -174,25 +182,25 @@ symbols, and premium hooks (if available):
or all packages with a specified version number: 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' $ 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*' $ sudo dnf install 'isc-kea*2.4.0-isc20230921141113*'
.. tab:: Alpine * - Alpine
.. code-block:: console - 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: but it can be simulated with the following command:
.. code-block:: console .. code-block:: console

1
doc/sphinx/conf.py
View File

@ -59,7 +59,6 @@ dashed_version_series='-'.join(version.split('.')[0:2])
extensions = [ extensions = [
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.mathjax', 'sphinx.ext.mathjax',
'sphinx_tabs.tabs',
] ]
# The suffix(es) of source filenames. # The suffix(es) of source filenames.

1
doc/sphinx/src/requirements.in
View File

@ -1,3 +1,2 @@
sphinx sphinx
sphinx-rtd-theme sphinx-rtd-theme
sphinx-tabs

14
doc/sphinx/src/requirements.txt
View File

@ -6,17 +6,16 @@
# #
alabaster==0.7.13 alabaster==0.7.13
# via sphinx # via sphinx
babel==2.13.0 babel==2.13.1
# via sphinx # via sphinx
certifi==2023.7.22 certifi==2023.7.22
# via requests # via requests
charset-normalizer==3.3.0 charset-normalizer==3.3.2
# via requests # via requests
docutils==0.18.1 docutils==0.18.1
# via # via
# sphinx # sphinx
# sphinx-rtd-theme # sphinx-rtd-theme
# sphinx-tabs
idna==3.4 idna==3.4
# via requests # via requests
imagesize==1.4.1 imagesize==1.4.1
@ -28,9 +27,7 @@ markupsafe==2.1.3
packaging==23.2 packaging==23.2
# via sphinx # via sphinx
pygments==2.16.1 pygments==2.16.1
# via # via sphinx
# sphinx
# sphinx-tabs
requests==2.31.0 requests==2.31.0
# via sphinx # via sphinx
snowballstemmer==2.2.0 snowballstemmer==2.2.0
@ -39,7 +36,6 @@ sphinx==7.2.6
# via # via
# -r ./src/requirements.in # -r ./src/requirements.in
# sphinx-rtd-theme # sphinx-rtd-theme
# sphinx-tabs
# sphinxcontrib-applehelp # sphinxcontrib-applehelp
# sphinxcontrib-devhelp # sphinxcontrib-devhelp
# sphinxcontrib-htmlhelp # sphinxcontrib-htmlhelp
@ -48,8 +44,6 @@ sphinx==7.2.6
# sphinxcontrib-serializinghtml # sphinxcontrib-serializinghtml
sphinx-rtd-theme==1.3.0 sphinx-rtd-theme==1.3.0
# via -r ./src/requirements.in # via -r ./src/requirements.in
sphinx-tabs==3.4.1
# via -r ./src/requirements.in
sphinxcontrib-applehelp==1.0.7 sphinxcontrib-applehelp==1.0.7
# via sphinx # via sphinx
sphinxcontrib-devhelp==1.0.5 sphinxcontrib-devhelp==1.0.5
@ -64,5 +58,5 @@ sphinxcontrib-qthelp==1.0.6
# via sphinx # via sphinx
sphinxcontrib-serializinghtml==1.1.9 sphinxcontrib-serializinghtml==1.1.9
# via sphinx # via sphinx
urllib3==2.0.6 urllib3==2.0.7
# via requests # via requests