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
Sphinx>=3.0.0
-sphinx-tabs
breathe
-json-schema-for-humans
sphinx_rtd_theme
extensions = [
'sphinx.ext.todo',
'sphinx.ext.viewcode',
- 'sphinx_tabs.tabs',
]
theme_major = sphinx_rtd_theme.__version__.partition('.')[0]
.. 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>_`.
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.
[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'
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