From: Aleš Mrázek Date: Wed, 14 Jan 2026 23:04:13 +0000 (+0100) Subject: docs: removed sphinx-tabs and json-schema-for-humans X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2bfee837e27a08a86d5084dbc7111f8a5bfdeb80;p=thirdparty%2Fknot-resolver.git docs: removed sphinx-tabs and json-schema-for-humans --- diff --git a/doc/meson.build b/doc/meson.build index c03bad3ae..0ac8f8a10 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -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 diff --git a/doc/requirements.txt b/doc/requirements.txt index 6a2487f5f..2990a45bf 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,3 @@ Sphinx>=3.0.0 -sphinx-tabs breathe -json-schema-for-humans sphinx_rtd_theme diff --git a/doc/user/conf.py b/doc/user/conf.py index 8f0e06538..4fa364951 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -21,7 +21,6 @@ release = version extensions = [ 'sphinx.ext.todo', 'sphinx.ext.viewcode', - 'sphinx_tabs.tabs', ] theme_major = sphinx_rtd_theme.__version__.partition('.')[0] diff --git a/doc/user/config-overview.rst b/doc/user/config-overview.rst index 5f5edc732..d258d1e73 100644 --- a/doc/user/config-overview.rst +++ b/doc/user/config-overview.rst @@ -59,15 +59,4 @@ Getting the JSON Schema .. tip:: - For the schema readability, some graphical visualizer can be used, for example `this one `_. - - -Interactive visualization -------------------------- - -The following visualization is interactive and offers good overview of the configuration structure. - -.. raw:: html - - Open in a new tab. - + For the schema readability, some graphical visualizer can be used, for example `json-schema.app _`. diff --git a/doc/user/gettingstarted-install.rst b/doc/user/gettingstarted-install.rst index 788eabe25..ab63c1be3 100644 --- a/doc/user/gettingstarted-install.rst +++ b/doc/user/gettingstarted-install.rst @@ -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. diff --git a/pyproject.toml b/pyproject.toml index dec38f0b1..a9d6b2c08 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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' diff --git a/scripts/meson/make-doc.sh b/scripts/meson/make-doc.sh index 1bea3df98..dc3b2bed3 100755 --- a/scripts/meson/make-doc.sh +++ b/scripts/meson/make-doc.sh @@ -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