doc: add internal architecture section

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>

Author: acerv

doc/conf.py

@@ -21,6 +21,8 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.inheritance_diagram",
     "myst_parser",
 ]
 

doc/index.rst

@@ -24,6 +24,7 @@
    :caption: For maintainers
 
    maintainers/release
+   maintainers/architecture
    kirk/modules
 
 For users
@@ -56,5 +57,8 @@ For maintainers
 :doc:`maintainers/release`
    How to create a kirk release
 
+:doc:`maintainers/architecture`
+   Internal kirk architecture
+
 :doc:`kirk/modules`
    Internal kirk API

doc/maintainers/architecture.rst

@@ -0,0 +1,101 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Internal architecture
+=====================
+
+.. warning::
+
+   The internal architecture might change over time.
+
+Overview
+--------
+
+.. graphviz::
+   
+   digraph {
+      newrank=true;
+
+      subgraph cluster_0 {
+         label = "Scheduler";
+         labeljust = "l";
+
+         SuiteScheduler;
+         TestScheduler;
+
+         SuiteScheduler -> TestScheduler;
+      }
+
+      subgraph cluster_1 {
+         label = "Communication";
+         labeljust = "l";
+
+         ComChannel;
+         ShellComChannel;
+         LTXComChannel;
+         QemuComChannel;
+         SSHComChannel;
+
+         ComChannel -> ShellComChannel;
+         ComChannel -> LTXComChannel;
+         ComChannel -> QemuComChannel;
+         ComChannel -> SSHComChannel;
+      }
+
+      subgraph cluster_2 {
+         label = "Framework";
+         labeljust = "r";
+
+         LTPFramework;
+      }
+
+      subgraph cluster_3 {
+         label = "SUT";
+         labeljust = "l";
+
+         GenericSUT;
+      }
+
+      {
+         rank=same;
+         SuiteScheduler;
+         LTPFramework;
+      }
+
+      Session -> SuiteScheduler;
+      TestScheduler -> GenericSUT;
+      GenericSUT -> ComChannel;
+
+      Session -> LTPFramework;
+      TestScheduler -> LTPFramework;
+   }
+
+|
+|
+
+Plugins system
+--------------
+
+.. inheritance-diagram::
+   libkirk.com.ComChannel
+   libkirk.plugin.Plugin
+   libkirk.sut.SUT
+   libkirk.sut_base.GenericSUT
+   libkirk.channels.shell.ShellComChannel
+   libkirk.channels.ltx_chan.LTXComChannel
+   libkirk.channels.qemu.QemuComChannel
+   libkirk.channels.ssh.SSHComChannel
+   :include-subclasses:
+   :parts: 1
+
+|
+|
+
+Exceptions
+----------
+
+.. inheritance-diagram::
+   libkirk.errors
+   :parts: 1
+
+|
+|