]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
docs: removed sphinx-tabs and json-schema-for-humans docs-docs-cleanup-cyjba3/deployments/8350 1792/head
authorAleš Mrázek <ales.mrazek@nic.cz>
Wed, 14 Jan 2026 23:04:13 +0000 (00:04 +0100)
committerAleš Mrázek <ales.mrazek@nic.cz>
Wed, 14 Jan 2026 23:35:03 +0000 (00:35 +0100)
doc/meson.build
doc/requirements.txt
doc/user/conf.py
doc/user/config-overview.rst
doc/user/gettingstarted-install.rst
pyproject.toml
scripts/meson/make-doc.sh

index c03bad3ae98336cbf0ede05f7a2c811d732d14ce..0ac8f8a10f249c57163b90d5ad23cca729c82dde 100644 (file)
@@ -51,16 +51,6 @@ if get_option('doc') == 'enabled'
     error('missing doc dependency: python sphinx_rtd_theme')
   endif
 
-  python_sphinx_tabs = run_command(python, '-c', 'import sphinx_tabs', check: false)
-  if python_sphinx_tabs.returncode() != 0
-    error('missing doc dependency: python python-sphinx-tabs')
-  endif
-
-  jsonschemaforhumans = run_command(python, '-c', 'import json_schema_for_humans', check: false)
-  if jsonschemaforhumans.returncode() != 0
-    error('missing doc dependency: python json-schema-for-humans')
-  endif
-
   message('------------------------')
 
   # install html docs
index 6a2487f5f6e1edd88b7a31de2c885265d5c15b61..2990a45bf76591b1e48f169aa27c259d4cfa7a84 100644 (file)
@@ -1,5 +1,3 @@
 Sphinx>=3.0.0
-sphinx-tabs
 breathe
-json-schema-for-humans
 sphinx_rtd_theme
index 8f0e065389a3a4e93686727c761807ede678da4d..4fa364951d124258662fceaddd623ed27d81523b 100644 (file)
@@ -21,7 +21,6 @@ release = version
 extensions = [
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
-    'sphinx_tabs.tabs',
 ]
 
 theme_major = sphinx_rtd_theme.__version__.partition('.')[0]
index 5f5edc7322366a6916088d9b098c47bed5983fa9..d258d1e73b9244c4153e1a440d929b41f9698dd3 100644 (file)
@@ -59,15 +59,4 @@ Getting the JSON Schema
 
 .. tip::
 
-    For the schema readability, some graphical visualizer can be used, for example `this one <https://json-schema.app/>`_.
-
-
-Interactive visualization
--------------------------
-
-The following visualization is interactive and offers good overview of the configuration structure.
-
-.. raw:: html
-
-    <a href="_static/schema_doc.html" target="_blank">Open in a new tab.</a>
-    <iframe src="_static/schema_doc.html" width="100%" style="height: 30vh;"></iframe>
+    For the schema readability, some graphical visualizer can be used, for example `json-schema.app <https://json-schema.app/view/%23?url=https%3A%2F%2Fwww.knot-resolver.cz%2Fdocumentation%2Flatest%2F_static%2Fconfig.schema.json>_`.
index 788eabe259c73d618ae1af0ca0d1e33d6e5a5630..ab63c1be3158134bb3cdc83961dd7edf7c44028e 100644 (file)
@@ -12,25 +12,29 @@ Therefore we recommend to use upstream repositories which have the **latest stab
 
 Please, follow the instructions for your packaging system:
 
-.. tabs::
+--------------------
+.deb (Debian/Ubuntu)
+--------------------
 
-    .. tab:: Debian/Ubuntu
+Please follow https://pkg.labs.nic.cz/doc/?project=knot-resolver
 
-        Please follow https://pkg.labs.nic.cz/doc/?project=knot-resolver
+---------------------------
+.rpm (Fedora/EPEL/openSUSE)
+---------------------------
 
-    .. tab:: .rpm
+Please follow https://copr.fedorainfracloud.org/coprs/g/cznic/knot-resolver/
 
-        Please follow https://copr.fedorainfracloud.org/coprs/g/cznic/knot-resolver/
+------
+Docker
+------
 
-    .. tab:: Docker
+DockerHub page: https://hub.docker.com/r/cznic/knot-resolver
 
-        DockerHub page: https://hub.docker.com/r/cznic/knot-resolver
+.. code:: bash
 
-        .. code:: bash
+    sudo docker run --rm -ti --network host docker.io/cznic/knot-resolver
 
-            sudo docker run --rm -ti --network host docker.io/cznic/knot-resolver
-
-        More about Docker deployments can be found in :ref:`deployment-docker` section.
+More about Docker deployments can be found in :ref:`deployment-docker` section.
 
 If for some reason you need to install Knot Resolver **from sources**,
 check out `building from sources <./dev/build.html>`_ section in developer documentation.
index dec38f0b1b554ae610400534e7f1049ffc5d6c71..a9d6b2c083e0853ff05ab67c4b48166fca651e18 100644 (file)
@@ -63,10 +63,8 @@ types-pyyaml = "^6.0.12.20241230"
 
 [tool.poetry.group.docs.dependencies]
 sphinx = "^5.3.0"
-sphinx-tabs = "^3.4.7"
 sphinx-rtd-theme = "^2.0.0"
 breathe = "^4.35.0"
-json-schema-for-humans = "^0.47.5"
 
 [tool.poetry.scripts]
 kresctl = 'knot_resolver.client.main:main'
index 1bea3df98930dff18dca2710989b75c2e3dfac09..dc3b2bed378e1264ea1e384475aabb5004f788b0 100755 (executable)
@@ -3,9 +3,6 @@
 set -o errexit -o nounset
 cd "$(dirname "${0}")/../.."
 
-# convert JSON schema to html
-generate-schema-doc --config expand_buttons=true doc/_static/config.schema.json doc/_static/schema_doc.html
-
 # generating the user documentation
 SPHINX=$(type -P sphinx-build-3 sphinx-build | head -n1)
 rm -rf doc/html