From: Aleš <ales.mrazek@nic.cz>
Date: Wed, 9 Jun 2021 21:16:48 +0000 (+0200)
Subject: docs: basic structure
X-Git-Tag: v6.0.0a1~147
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7c91c1406dde6f9f32fecc6eeb3c67606322d591;p=thirdparty%2Fknot-resolver.git

docs: basic structure
---

diff --git a/manager/docs/conf.py b/manager/docs/conf.py
index 193d8dd65..16c089191 100644
--- a/manager/docs/conf.py
+++ b/manager/docs/conf.py
@@ -10,9 +10,10 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../.'))
 
 # import sphinx_rtd_theme
 
@@ -22,15 +23,19 @@ project = 'knot-resolver-manager'
 copyright = '2021, CZ.NIC, z. s. p. o.'
 author = 'Aleš Mrázek'
 
+# The suffix of source filenames.
+source_suffix = '.rst'
+master_doc = 'index'
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-# extensions = [
-#     'sphinx_rtd_theme',
-# ]
+extensions = [
+    # 'sphinx_rtd_theme',
+    'sphinx.ext.autodoc'
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -45,7 +50,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
+
 # html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
diff --git a/manager/docs/configuration.rst b/manager/docs/configuration.rst
new file mode 100644
index 000000000..55f9f3f7e
--- /dev/null
+++ b/manager/docs/configuration.rst
@@ -0,0 +1,44 @@
+*************************
+Declarative configuration
+*************************
+
+.. contents::
+    :depth: 2
+    :local:
+
+Final documentation will be generated from configuration datamodel.
+This is just a raw proposal.
+
+server
+======
+
+.. envvar:: server:hostname: <str>
+
+    Detailed information probably from python docstring.
+
+network
+=======
+
+.. envvar:: network:interfaces: <list>
+
+    .. envvar:: listen: <ip-address>[@port]
+
+    .. envvar:: kind: <dns|xdp|dot|doh|control>
+
+        :default: dns
+
+    .. envvar:: freebind: <bool>
+
+        :default: false
+
+    Example:
+
+    .. code-block:: yaml
+
+        network:
+            interfaces:
+              - listen: eth0@53
+
+
+
+
diff --git a/manager/docs/getting-started.rst b/manager/docs/getting-started.rst
new file mode 100644
index 000000000..6c6f84a01
--- /dev/null
+++ b/manager/docs/getting-started.rst
@@ -0,0 +1,16 @@
+***************
+Getting started
+***************
+
+.. contents::
+    :depth: 1
+    :local:
+
+Introduction
+============
+
+How to use
+==========
+
+Migration
+=========
diff --git a/manager/docs/index.rst b/manager/docs/index.rst
index ae51ed819..db8f7220d 100644
--- a/manager/docs/index.rst
+++ b/manager/docs/index.rst
@@ -1,12 +1,15 @@
-Welcome to knot-resolver-manager's documentation!
-=================================================
+=====================
+Knot Resolver Manager
+=====================
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
+    :maxdepth: 2
+    :caption: Manager:
 
+    getting-started
+    configuration
 
+==================
 Indices and tables
 ==================