New kirk documentation

Use sphinx to generate the kirk documentation. This includes three
section as it is for the LTP project, with C API section as well.
README is now using the RST format, since it's the default type used by
sphinx.

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

Author: acerv

README.md

@@ -0,0 +1,52 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+What is Kirk?
+=============
+
+Kirk application is a fork of `runltp-ng <https://github.com/linux-test-project/runltp-ng>`_
+and it's the official `LTP <https://github.com/linux-test-project>`_ tests
+executor. It provides support for remote testing via Qemu, SSH, LTX, parallel
+execution and much more.
+
+.. code-block:: bash
+
+    Host information
+
+            Hostname:   susy
+            Python:     3.6.15 (default, Sep 23 2021, 15:41:43) [GCC]
+            Directory:  /tmp/kirk.acer/tmp1n8pa6gy
+
+    Connecting to SUT: host
+
+    Starting suite: math
+    ---------------------
+    abs01: pass  (0.003s)
+    atof01: pass  (0.004s)
+    float_bessel: pass  (1.174s)
+    float_exp_log: pass  (1.423s)
+    float_iperb: pass  (0.504s)
+    float_power: pass  (1.161s)
+    float_trigo: pass  (1.208s)
+    fptest01: pass  (0.006s)
+    fptest02: pass  (0.004s)
+    nextafter01: pass  (0.001s)
+
+    Execution time: 5.895s
+
+            Suite:       math
+            Total runs:  10
+            Runtime:     5.488s
+            Passed:      22
+            Failed:      0
+            Skipped:     0
+            Broken:      0
+            Warnings:    0
+            Kernel:      Linux 6.4.0-150600.23.50-default
+            Machine:     x86_64
+            Arch:        x86_64
+            RAM:         15573156 kB
+            Swap:        2095424 kB
+            Distro:      opensuse-leap 15.6
+
+    Disconnecting from SUT: host
+

README.rst

@@ -0,0 +1,2 @@
+kirk
+html

doc/.gitignore

@@ -0,0 +1,70 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('..'))
+
+project = 'kirk'
+copyright = '2025, Linux Test Project'
+author = 'Linux Test Project'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.viewcode',
+    'myst_parser'
+]
+
+templates_path = ['_templates']
+exclude_patterns = ["html*"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = []
+
+
+def run_apidoc(_):
+    """
+    Autogenerate API documentation.
+    """
+    packages = {
+        "kirk": "../libkirk",
+    }
+
+    argv_list = []
+    for output, source in packages.items():
+        argv_list.append([
+            "-f",
+            "-o",
+            output,
+            source,
+            "../libkirk/tests/"
+        ])
+
+    try:
+        # Sphinx 1.7+
+        from sphinx.ext import apidoc
+        for argv in argv_list:
+            apidoc.main(argv)
+    except ImportError:
+        # Sphinx 1.6 (and earlier)
+        from sphinx import apidoc
+        for argv in argv_list:
+            argv.insert(0, apidoc.__file__)
+            apidoc.main(argv)
+
+
+def setup(app):
+    app.connect('builder-inited', run_apidoc)

doc/conf.py

@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Implementing a new Framework
+============================
+
+Every testing framework has its own setup, defining tests folders, data, and
+variables. For this reason, the `Framework` class provides a generic API that,
+once implemented, allows you to define a specific testing framework. 
+
+The class implementation must be included inside the `libkirk` folder and will
+be used as an abstraction layer between the `kirk` scheduler and the specific
+testing framewiork.

doc/developers/framework.rst

@@ -0,0 +1,20 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Implementing a new SUT
+======================
+
+Sometimes we need to cover complex testing scenarios, where the SUT
+(System Under Test) uses particular protocols and infrastructures to
+communicate with our host machine and execute test binaries.
+
+For this reason, `kirk` provides a plugin system to recognize custom SUT class
+implementations inside the `libkirk` folder. Please check the `host.py` or
+`ssh.py` implementations for more details.
+
+Once a new SUT class is implemented and placed inside the `libkirk` folder, you
+can use the following command to see if the application correctly recognizes it:
+
+.. code-block:: bash
+
+    kirk -s help
+