]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
docs: split user/expert/devel docs in TOC
authorPetr Špaček <petr.spacek@nic.cz>
Fri, 8 Mar 2019 19:25:15 +0000 (20:25 +0100)
committerTomas Krizek <tomas.krizek@nic.cz>
Tue, 12 Mar 2019 09:46:45 +0000 (10:46 +0100)
daemon/README.rst
doc/index.rst
doc/modules.rst

index a81c819cedb5a59b0acfe32d7967fefb952a72fe..2bcd35bd92c4fa0e7399b7d5c45d6404dfbcc9b2 100644 (file)
@@ -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 <keyfile>``
-   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 <keyfile>``
+   and ``trust_anchors.file = keyfile``.
+
 .. envvar:: trust_anchors.keyfile_default = keyfile_default
 
    Set by ``keyfile_default`` option during compilation. This can be explicitly
index 17ab4f1b7e2d32d38751910053fa0754ed940e41..45d7c8f970fb469a0b84602d1fb2d0d702526ef2 100644 (file)
@@ -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
index ce659408d9e810cd6c51af6e65831d8e13e2cf1f..4209fed5f649a3ee6ceff1fc54d47fb26993e0fe 100644 (file)
@@ -1,8 +1,8 @@
 .. _modules-implemented:
 
-*********************
-Knot Resolver modules
-*********************
+*******
+Modules
+*******
 
 .. contents::
    :depth: 1