From aede9b4901de4cdcce26966c95b96e76905db374 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Petr=20=C5=A0pa=C4=8Dek?= Date: Fri, 8 Mar 2019 20:25:15 +0100 Subject: [PATCH] docs: split user/expert/devel docs in TOC --- daemon/README.rst | 16 ++++++++-------- doc/index.rst | 22 ++++++++++++++++++++-- doc/modules.rst | 6 +++--- 3 files changed, 31 insertions(+), 13 deletions(-) diff --git a/daemon/README.rst b/daemon/README.rst index a81c819ce..2bcd35bd9 100644 --- a/daemon/README.rst +++ b/daemon/README.rst @@ -1,6 +1,6 @@ -************************ -Knot Resolver daemon -************************ +****** +Daemon +****** The server is in the `daemon` directory, it works out of the box without any configuration. @@ -398,11 +398,6 @@ and :rfc:`7646` negative trust anchors. Depending on your distribution, DNSSEC trust anchors should be either maintained in accordance with the distro-wide policy, or automatically maintained by the resolver itself. -.. function:: trust_anchors.config(keyfile, readonly) - - Alias for `add_file`. It is also equivalent to CLI parameter ``-k `` - and ``trust_anchors.file = keyfile``. - .. function:: trust_anchors.add_file(keyfile, readonly) :param string keyfile: path to the file. @@ -426,6 +421,11 @@ policy, or automatically maintained by the resolver itself. [ ta ] key: 19036 state: Valid +.. function:: trust_anchors.config(keyfile, readonly) + + Alias for `add_file`. It is also equivalent to CLI parameter ``-k `` + and ``trust_anchors.file = keyfile``. + .. envvar:: trust_anchors.keyfile_default = keyfile_default Set by ``keyfile_default`` option during compilation. This can be explicitly diff --git a/doc/index.rst b/doc/index.rst index 17ab4f1b7..45d7c8f97 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -7,15 +7,33 @@ Modular architecture keeps the core tiny and efficient, and it provides a state-machine like API for extensions. .. toctree:: + :caption: Users + :name: users :maxdepth: 2 daemon modules + +.. toctree:: + :maxdepth: 1 + + upgrading + NEWS + +.. toctree:: + :caption: Experts + :name: experts + :maxdepth: 2 + build + +.. toctree:: + :caption: Developers + :name: developers + :maxdepth: 2 + lib modules_api - upgrading - NEWS Indices and tables diff --git a/doc/modules.rst b/doc/modules.rst index ce659408d..4209fed5f 100644 --- a/doc/modules.rst +++ b/doc/modules.rst @@ -1,8 +1,8 @@ .. _modules-implemented: -********************* -Knot Resolver modules -********************* +******* +Modules +******* .. contents:: :depth: 1 -- 2.47.2