From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 3CFA2454E2;
	Mon, 24 Jun 2024 16:26:23 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id C1E3F40E4F;
	Mon, 24 Jun 2024 16:26:17 +0200 (CEST)
Received: from mail-lj1-f182.google.com (mail-lj1-f182.google.com
 [209.85.208.182])
 by mails.dpdk.org (Postfix) with ESMTP id 317D940E38
 for <dev@dpdk.org>; Mon, 24 Jun 2024 16:26:00 +0200 (CEST)
Received: by mail-lj1-f182.google.com with SMTP id
 38308e7fff4ca-2eaae2a6dc1so71953521fa.0
 for <dev@dpdk.org>; Mon, 24 Jun 2024 07:26:00 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=pantheon.tech; s=google; t=1719239159; x=1719843959; darn=dpdk.org;
 h=content-transfer-encoding:mime-version:references:in-reply-to
 :message-id:date:subject:cc:to:from:from:to:cc:subject:date
 :message-id:reply-to;
 bh=9QgqLV6nUu3aoeRfDZq9bScDQhJXKy+kDLe7uopd/yI=;
 b=tnO9gag8RYHoGSI9pcPSc/fjv03gEm7TSUhKjoXcwnBynYB95XQaH2jhm2LMhgzE3m
 yfaebjZCzNNeYbmPt6aqkgxcaMWgRtcJA5Vo+YUvuoA3AFkaC+b8ol8ZBULvioGlbL8q
 QmxRizA8owyAJnFVLJ1tyKCRil1+AEJZp1nXKfUs//wHr20zOyBXwXvXcP/kg+1GryYk
 aS+BZQuyisAF56vjcHxgTx5m1QuXXW0f8xL/PprqO8j+i1XzQZo2jW5tAMrAS/nBgOlt
 CK4ZJBvYZkrCRC7TztUbypq92PokMdhbOJtVL9z7fmhETSSh2RDIwCytxYox2eaaGMZQ
 0InQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1719239159; x=1719843959;
 h=content-transfer-encoding:mime-version:references:in-reply-to
 :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
 :subject:date:message-id:reply-to;
 bh=9QgqLV6nUu3aoeRfDZq9bScDQhJXKy+kDLe7uopd/yI=;
 b=TuLAfz8gsKvhdXJoMtG00qzYHIIQdGD8c2BqHEKVXGARPmiWFqp9p28sfAPMPz4+30
 bqtTAx0LygVk4hxtisaXktRQaCchS+sVA4unVtQdf+p/RhfHgD1dkJVcPO1r7LE5xDI7
 aGlilWwL1pEEevQUmEfTQK6ed+6Qx9JeQHgyg69tavjiIIL3uvRumF4zBdycbVz7/AR3
 OIq76sYDfnsPprLK0mK+FX74ua+QF6oo4NeL4VMZ3E5fuTx/jHaukYHyq1Ek/h473Yg2
 B494Mi7w05KVBvZ9lQ7NREwA9oAWR/FEZ7H2iTB/Gol08GPXRQZqDswUY7w2sPMttU8P
 Orfw==
X-Gm-Message-State: AOJu0YzKOMRRJVwo92EVECWULauavPCp5IFAHasH3p/IQbu70RCLoTbI
 CcIQgSa8ISMFdm5Hfmz9NHdZYtvYpc4lH1Hl9vVJecQH18amDyVd8HtTecJGMoJixf/edDlYb4T
 UpH4=
X-Google-Smtp-Source: AGHT+IFTaVdO6JrVvgfNTkGnyQO6FCHAoPy8juKbj5F/Wfnt0VgKROLB5GWv1pJ6ivwydYsgMYN4ww==
X-Received: by 2002:a2e:9057:0:b0:2ec:18bc:c455 with SMTP id
 38308e7fff4ca-2ec5b2c4dbdmr37503651fa.10.1719239159532; 
 Mon, 24 Jun 2024 07:25:59 -0700 (PDT)
Received: from localhost.localdomain ([84.245.121.236])
 by smtp.gmail.com with ESMTPSA id
 a640c23a62f3a-a72521c9514sm136964566b.6.2024.06.24.07.25.58
 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
 Mon, 24 Jun 2024 07:25:59 -0700 (PDT)
From: =?UTF-8?q?Juraj=20Linke=C5=A1?= <juraj.linkes@pantheon.tech>
To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com,
 bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu,
 paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu
Cc: dev@dpdk.org, =?UTF-8?q?Juraj=20Linke=C5=A1?= <juraj.linkes@pantheon.tech>,
 Luca Vizzarro <luca.vizzarro@arm.com>
Subject: [PATCH v7 3/4] dts: add API doc sources
Date: Mon, 24 Jun 2024 16:25:43 +0200
Message-Id: <20240624142544.35644-4-juraj.linkes@pantheon.tech>
X-Mailer: git-send-email 2.34.1
In-Reply-To: <20240624142544.35644-1-juraj.linkes@pantheon.tech>
References: <20231115133606.42081-1-juraj.linkes@pantheon.tech>
 <20240624142544.35644-1-juraj.linkes@pantheon.tech>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

These sources could be generated with the sphinx-apidoc utility, but
that doesn't give us enough flexibility, such as sorting the order of
modules or changing the headers of the modules.

The sources included in this patch were in fact generated by said
utility, but modified to improve the look of the documentation. The
improvements are mainly in toctree definitions and the titles of the
modules/packages. These were made with specific Sphinx config options in
mind.

Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
Reviewed-by: Luca Vizzarro <luca.vizzarro@arm.com>
Reviewed-by: Jeremy Spewock <jspewock@iol.unh.edu>
Tested-by: Luca Vizzarro <luca.vizzarro@arm.com>
---
 dts/doc/conf_yaml_schema.json                 |  1 +
 dts/doc/framework.config.rst                  | 12 ++++++
 dts/doc/framework.config.types.rst            |  6 +++
 dts/doc/framework.exception.rst               |  6 +++
 dts/doc/framework.logger.rst                  |  6 +++
 dts/doc/framework.params.eal.rst              |  6 +++
 dts/doc/framework.params.rst                  | 14 ++++++
 dts/doc/framework.params.testpmd.rst          |  6 +++
 dts/doc/framework.params.types.rst            |  6 +++
 dts/doc/framework.parser.rst                  |  6 +++
 .../framework.remote_session.dpdk_shell.rst   |  6 +++
 ...ote_session.interactive_remote_session.rst |  6 +++
 ...ework.remote_session.interactive_shell.rst |  6 +++
 .../framework.remote_session.python_shell.rst |  6 +++
 ...ramework.remote_session.remote_session.rst |  6 +++
 dts/doc/framework.remote_session.rst          | 18 ++++++++
 .../framework.remote_session.ssh_session.rst  |  6 +++
 ...framework.remote_session.testpmd_shell.rst |  6 +++
 dts/doc/framework.runner.rst                  |  6 +++
 dts/doc/framework.settings.rst                |  6 +++
 dts/doc/framework.test_result.rst             |  6 +++
 dts/doc/framework.test_suite.rst              |  6 +++
 dts/doc/framework.testbed_model.cpu.rst       |  6 +++
 .../framework.testbed_model.linux_session.rst |  6 +++
 dts/doc/framework.testbed_model.node.rst      |  6 +++
 .../framework.testbed_model.os_session.rst    |  6 +++
 dts/doc/framework.testbed_model.port.rst      |  6 +++
 .../framework.testbed_model.posix_session.rst |  6 +++
 dts/doc/framework.testbed_model.rst           | 26 +++++++++++
 dts/doc/framework.testbed_model.sut_node.rst  |  6 +++
 dts/doc/framework.testbed_model.tg_node.rst   |  6 +++
 ..._generator.capturing_traffic_generator.rst |  6 +++
 ...mework.testbed_model.traffic_generator.rst | 14 ++++++
 ....testbed_model.traffic_generator.scapy.rst |  6 +++
 ...el.traffic_generator.traffic_generator.rst |  6 +++
 ...framework.testbed_model.virtual_device.rst |  6 +++
 dts/doc/framework.utils.rst                   |  6 +++
 dts/doc/index.rst                             | 43 +++++++++++++++++++
 38 files changed, 314 insertions(+)
 create mode 120000 dts/doc/conf_yaml_schema.json
 create mode 100644 dts/doc/framework.config.rst
 create mode 100644 dts/doc/framework.config.types.rst
 create mode 100644 dts/doc/framework.exception.rst
 create mode 100644 dts/doc/framework.logger.rst
 create mode 100644 dts/doc/framework.params.eal.rst
 create mode 100644 dts/doc/framework.params.rst
 create mode 100644 dts/doc/framework.params.testpmd.rst
 create mode 100644 dts/doc/framework.params.types.rst
 create mode 100644 dts/doc/framework.parser.rst
 create mode 100644 dts/doc/framework.remote_session.dpdk_shell.rst
 create mode 100644 dts/doc/framework.remote_session.interactive_remote_session.rst
 create mode 100644 dts/doc/framework.remote_session.interactive_shell.rst
 create mode 100644 dts/doc/framework.remote_session.python_shell.rst
 create mode 100644 dts/doc/framework.remote_session.remote_session.rst
 create mode 100644 dts/doc/framework.remote_session.rst
 create mode 100644 dts/doc/framework.remote_session.ssh_session.rst
 create mode 100644 dts/doc/framework.remote_session.testpmd_shell.rst
 create mode 100644 dts/doc/framework.runner.rst
 create mode 100644 dts/doc/framework.settings.rst
 create mode 100644 dts/doc/framework.test_result.rst
 create mode 100644 dts/doc/framework.test_suite.rst
 create mode 100644 dts/doc/framework.testbed_model.cpu.rst
 create mode 100644 dts/doc/framework.testbed_model.linux_session.rst
 create mode 100644 dts/doc/framework.testbed_model.node.rst
 create mode 100644 dts/doc/framework.testbed_model.os_session.rst
 create mode 100644 dts/doc/framework.testbed_model.port.rst
 create mode 100644 dts/doc/framework.testbed_model.posix_session.rst
 create mode 100644 dts/doc/framework.testbed_model.rst
 create mode 100644 dts/doc/framework.testbed_model.sut_node.rst
 create mode 100644 dts/doc/framework.testbed_model.tg_node.rst
 create mode 100644 dts/doc/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst
 create mode 100644 dts/doc/framework.testbed_model.traffic_generator.rst
 create mode 100644 dts/doc/framework.testbed_model.traffic_generator.scapy.rst
 create mode 100644 dts/doc/framework.testbed_model.traffic_generator.traffic_generator.rst
 create mode 100644 dts/doc/framework.testbed_model.virtual_device.rst
 create mode 100644 dts/doc/framework.utils.rst
 create mode 100644 dts/doc/index.rst

diff --git a/dts/doc/conf_yaml_schema.json b/dts/doc/conf_yaml_schema.json
new file mode 120000
index 0000000000..d89eb81b72
--- /dev/null
+++ b/dts/doc/conf_yaml_schema.json
@@ -0,0 +1 @@
+../framework/config/conf_yaml_schema.json
\ No newline at end of file
diff --git a/dts/doc/framework.config.rst b/dts/doc/framework.config.rst
new file mode 100644
index 0000000000..f765ef0e32
--- /dev/null
+++ b/dts/doc/framework.config.rst
@@ -0,0 +1,12 @@
+config - Configuration Package
+==============================
+
+.. automodule:: framework.config
+   :members:
+   :show-inheritance:
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   framework.config.types
diff --git a/dts/doc/framework.config.types.rst b/dts/doc/framework.config.types.rst
new file mode 100644
index 0000000000..ed52bf5d3e
--- /dev/null
+++ b/dts/doc/framework.config.types.rst
@@ -0,0 +1,6 @@
+config.types - Configuration Types
+==================================
+
+.. automodule:: framework.config.types
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.exception.rst b/dts/doc/framework.exception.rst
new file mode 100644
index 0000000000..ad58bd15de
--- /dev/null
+++ b/dts/doc/framework.exception.rst
@@ -0,0 +1,6 @@
+exception - Exceptions
+======================
+
+.. automodule:: framework.exception
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.logger.rst b/dts/doc/framework.logger.rst
new file mode 100644
index 0000000000..3c25b34819
--- /dev/null
+++ b/dts/doc/framework.logger.rst
@@ -0,0 +1,6 @@
+logger - Logging Facility
+=========================
+
+.. automodule:: framework.logger
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.params.eal.rst b/dts/doc/framework.params.eal.rst
new file mode 100644
index 0000000000..3908f6d471
--- /dev/null
+++ b/dts/doc/framework.params.eal.rst
@@ -0,0 +1,6 @@
+eal - EAL Parameters Modelling
+==============================
+
+.. automodule:: framework.params.eal
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.params.rst b/dts/doc/framework.params.rst
new file mode 100644
index 0000000000..a273b6378a
--- /dev/null
+++ b/dts/doc/framework.params.rst
@@ -0,0 +1,14 @@
+params - Command Line Parameters Modelling
+==========================================
+
+.. automodule:: framework.params
+   :members:
+   :show-inheritance:
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   framework.params.eal
+   framework.params.testpmd
+   framework.params.types
diff --git a/dts/doc/framework.params.testpmd.rst b/dts/doc/framework.params.testpmd.rst
new file mode 100644
index 0000000000..5f25ed5528
--- /dev/null
+++ b/dts/doc/framework.params.testpmd.rst
@@ -0,0 +1,6 @@
+testpmd - TestPMD Parameters Modelling
+======================================
+
+.. automodule:: framework.params.testpmd
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.params.types.rst b/dts/doc/framework.params.types.rst
new file mode 100644
index 0000000000..9c68a7fab8
--- /dev/null
+++ b/dts/doc/framework.params.types.rst
@@ -0,0 +1,6 @@
+params.types - Parameters Modelling Types
+=========================================
+
+.. automodule:: framework.params.types
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.parser.rst b/dts/doc/framework.parser.rst
new file mode 100644
index 0000000000..a5e3264f35
--- /dev/null
+++ b/dts/doc/framework.parser.rst
@@ -0,0 +1,6 @@
+parser - Text Parsing Utilities
+===============================
+
+.. automodule:: framework.parser
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.remote_session.dpdk_shell.rst b/dts/doc/framework.remote_session.dpdk_shell.rst
new file mode 100644
index 0000000000..4402eba4fd
--- /dev/null
+++ b/dts/doc/framework.remote_session.dpdk_shell.rst
@@ -0,0 +1,6 @@
+dpdk\_shell - DPDK Interactive Remote Shell
+===========================================
+
+.. automodule:: framework.remote_session.dpdk_shell
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.remote_session.interactive_remote_session.rst b/dts/doc/framework.remote_session.interactive_remote_session.rst
new file mode 100644
index 0000000000..35dc5c4b03
--- /dev/null
+++ b/dts/doc/framework.remote_session.interactive_remote_session.rst
@@ -0,0 +1,6 @@
+interactive\_remote\_session - SSH Interactive Remote Session
+=============================================================
+
+.. automodule:: framework.remote_session.interactive_remote_session
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.remote_session.interactive_shell.rst b/dts/doc/framework.remote_session.interactive_shell.rst
new file mode 100644
index 0000000000..8a59db7b6e
--- /dev/null
+++ b/dts/doc/framework.remote_session.interactive_shell.rst
@@ -0,0 +1,6 @@
+interactive\_shell - Base Interactive Remote Shell
+==================================================
+
+.. automodule:: framework.remote_session.interactive_shell
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.remote_session.python_shell.rst b/dts/doc/framework.remote_session.python_shell.rst
new file mode 100644
index 0000000000..a8ec06f281
--- /dev/null
+++ b/dts/doc/framework.remote_session.python_shell.rst
@@ -0,0 +1,6 @@
+python\_shell - Python Interactive Remote Shell
+===============================================
+
+.. automodule:: framework.remote_session.python_shell
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.remote_session.remote_session.rst b/dts/doc/framework.remote_session.remote_session.rst
new file mode 100644
index 0000000000..58b0960d07
--- /dev/null
+++ b/dts/doc/framework.remote_session.remote_session.rst
@@ -0,0 +1,6 @@
+remote\_session - Remote Session ABC
+====================================
+
+.. automodule:: framework.remote_session.remote_session
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.remote_session.rst b/dts/doc/framework.remote_session.rst
new file mode 100644
index 0000000000..4e755b1fe3
--- /dev/null
+++ b/dts/doc/framework.remote_session.rst
@@ -0,0 +1,18 @@
+remote\_session - Node Connections Package
+==========================================
+
+.. automodule:: framework.remote_session
+   :members:
+   :show-inheritance:
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   framework.remote_session.remote_session
+   framework.remote_session.ssh_session
+   framework.remote_session.interactive_remote_session
+   framework.remote_session.interactive_shell
+   framework.remote_session.dpdk_shell
+   framework.remote_session.testpmd_shell
+   framework.remote_session.python_shell
diff --git a/dts/doc/framework.remote_session.ssh_session.rst b/dts/doc/framework.remote_session.ssh_session.rst
new file mode 100644
index 0000000000..05b019bc7c
--- /dev/null
+++ b/dts/doc/framework.remote_session.ssh_session.rst
@@ -0,0 +1,6 @@
+ssh\_session - SSH Remote Session
+=================================
+
+.. automodule:: framework.remote_session.ssh_session
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.remote_session.testpmd_shell.rst b/dts/doc/framework.remote_session.testpmd_shell.rst
new file mode 100644
index 0000000000..14510afb2b
--- /dev/null
+++ b/dts/doc/framework.remote_session.testpmd_shell.rst
@@ -0,0 +1,6 @@
+testpmd\_shell - Testpmd Interactive Remote Shell
+=================================================
+
+.. automodule:: framework.remote_session.testpmd_shell
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.runner.rst b/dts/doc/framework.runner.rst
new file mode 100644
index 0000000000..a1708f0002
--- /dev/null
+++ b/dts/doc/framework.runner.rst
@@ -0,0 +1,6 @@
+runner - Testbed Setup and Test Suite Runner
+============================================
+
+.. automodule:: framework.runner
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.settings.rst b/dts/doc/framework.settings.rst
new file mode 100644
index 0000000000..96bf194923
--- /dev/null
+++ b/dts/doc/framework.settings.rst
@@ -0,0 +1,6 @@
+settings - Command Line Arguments and Environment Variables
+===========================================================
+
+.. automodule:: framework.settings
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.test_result.rst b/dts/doc/framework.test_result.rst
new file mode 100644
index 0000000000..527357a04a
--- /dev/null
+++ b/dts/doc/framework.test_result.rst
@@ -0,0 +1,6 @@
+test\_result - Test Results Records
+===================================
+
+.. automodule:: framework.test_result
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.test_suite.rst b/dts/doc/framework.test_suite.rst
new file mode 100644
index 0000000000..96f893e465
--- /dev/null
+++ b/dts/doc/framework.test_suite.rst
@@ -0,0 +1,6 @@
+test\_suite - Common Test Suite Features
+========================================
+
+.. automodule:: framework.test_suite
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.cpu.rst b/dts/doc/framework.testbed_model.cpu.rst
new file mode 100644
index 0000000000..dd2baf09fb
--- /dev/null
+++ b/dts/doc/framework.testbed_model.cpu.rst
@@ -0,0 +1,6 @@
+cpu - CPU Representation and Utilities
+======================================
+
+.. automodule:: framework.testbed_model.cpu
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.linux_session.rst b/dts/doc/framework.testbed_model.linux_session.rst
new file mode 100644
index 0000000000..141f3f49e3
--- /dev/null
+++ b/dts/doc/framework.testbed_model.linux_session.rst
@@ -0,0 +1,6 @@
+linux\_session - Linux Remote Session
+=====================================
+
+.. automodule:: framework.testbed_model.linux_session
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.node.rst b/dts/doc/framework.testbed_model.node.rst
new file mode 100644
index 0000000000..2133dd604b
--- /dev/null
+++ b/dts/doc/framework.testbed_model.node.rst
@@ -0,0 +1,6 @@
+node - Base Node
+================
+
+.. automodule:: framework.testbed_model.node
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.os_session.rst b/dts/doc/framework.testbed_model.os_session.rst
new file mode 100644
index 0000000000..f3574e939a
--- /dev/null
+++ b/dts/doc/framework.testbed_model.os_session.rst
@@ -0,0 +1,6 @@
+os\_session - OS-aware Remote Session ABC
+=========================================
+
+.. automodule:: framework.testbed_model.os_session
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.port.rst b/dts/doc/framework.testbed_model.port.rst
new file mode 100644
index 0000000000..17bd391e63
--- /dev/null
+++ b/dts/doc/framework.testbed_model.port.rst
@@ -0,0 +1,6 @@
+port - NIC Port Representation
+==============================
+
+.. automodule:: framework.testbed_model.port
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.posix_session.rst b/dts/doc/framework.testbed_model.posix_session.rst
new file mode 100644
index 0000000000..308c051ae5
--- /dev/null
+++ b/dts/doc/framework.testbed_model.posix_session.rst
@@ -0,0 +1,6 @@
+posix\_session - Posix Remote Session
+=====================================
+
+.. automodule:: framework.testbed_model.posix_session
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.rst b/dts/doc/framework.testbed_model.rst
new file mode 100644
index 0000000000..4b024e47e6
--- /dev/null
+++ b/dts/doc/framework.testbed_model.rst
@@ -0,0 +1,26 @@
+testbed\_model - Testbed Modelling Package
+==========================================
+
+.. automodule:: framework.testbed_model
+   :members:
+   :show-inheritance:
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   framework.testbed_model.traffic_generator
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   framework.testbed_model.os_session
+   framework.testbed_model.linux_session
+   framework.testbed_model.posix_session
+   framework.testbed_model.node
+   framework.testbed_model.sut_node
+   framework.testbed_model.tg_node
+   framework.testbed_model.cpu
+   framework.testbed_model.port
+   framework.testbed_model.virtual_device
diff --git a/dts/doc/framework.testbed_model.sut_node.rst b/dts/doc/framework.testbed_model.sut_node.rst
new file mode 100644
index 0000000000..7e12b6c87e
--- /dev/null
+++ b/dts/doc/framework.testbed_model.sut_node.rst
@@ -0,0 +1,6 @@
+sut\_node - System Under Test Node
+==================================
+
+.. automodule:: framework.testbed_model.sut_node
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.tg_node.rst b/dts/doc/framework.testbed_model.tg_node.rst
new file mode 100644
index 0000000000..e56db8e782
--- /dev/null
+++ b/dts/doc/framework.testbed_model.tg_node.rst
@@ -0,0 +1,6 @@
+tg\_node - Traffic Generator Node
+=================================
+
+.. automodule:: framework.testbed_model.tg_node
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst b/dts/doc/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst
new file mode 100644
index 0000000000..06c087155a
--- /dev/null
+++ b/dts/doc/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst
@@ -0,0 +1,6 @@
+capturing\_traffic\_generator - Base Capturing TG ABC
+=====================================================
+
+.. automodule:: framework.testbed_model.traffic_generator.capturing_traffic_generator
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.traffic_generator.rst b/dts/doc/framework.testbed_model.traffic_generator.rst
new file mode 100644
index 0000000000..18b6f1b98b
--- /dev/null
+++ b/dts/doc/framework.testbed_model.traffic_generator.rst
@@ -0,0 +1,14 @@
+traffic\_generator Subpackage
+=============================
+
+.. automodule:: framework.testbed_model.traffic_generator
+   :members:
+   :show-inheritance:
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   framework.testbed_model.traffic_generator.traffic_generator
+   framework.testbed_model.traffic_generator.capturing_traffic_generator
+   framework.testbed_model.traffic_generator.scapy
diff --git a/dts/doc/framework.testbed_model.traffic_generator.scapy.rst b/dts/doc/framework.testbed_model.traffic_generator.scapy.rst
new file mode 100644
index 0000000000..7062914ec3
--- /dev/null
+++ b/dts/doc/framework.testbed_model.traffic_generator.scapy.rst
@@ -0,0 +1,6 @@
+scapy - Capturing Traffic Generator
+===================================
+
+.. automodule:: framework.testbed_model.traffic_generator.scapy
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.traffic_generator.traffic_generator.rst b/dts/doc/framework.testbed_model.traffic_generator.traffic_generator.rst
new file mode 100644
index 0000000000..e366d7f222
--- /dev/null
+++ b/dts/doc/framework.testbed_model.traffic_generator.traffic_generator.rst
@@ -0,0 +1,6 @@
+traffic\_generator - Base TG ABC
+================================
+
+.. automodule:: framework.testbed_model.traffic_generator.traffic_generator
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.testbed_model.virtual_device.rst b/dts/doc/framework.testbed_model.virtual_device.rst
new file mode 100644
index 0000000000..38e6c1d0bc
--- /dev/null
+++ b/dts/doc/framework.testbed_model.virtual_device.rst
@@ -0,0 +1,6 @@
+virtual\_device - Virtual Devices
+=================================
+
+.. automodule:: framework.testbed_model.virtual_device
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/framework.utils.rst b/dts/doc/framework.utils.rst
new file mode 100644
index 0000000000..0e7bb80666
--- /dev/null
+++ b/dts/doc/framework.utils.rst
@@ -0,0 +1,6 @@
+utils - Various Utilities
+=========================
+
+.. automodule:: framework.utils
+   :members:
+   :show-inheritance:
diff --git a/dts/doc/index.rst b/dts/doc/index.rst
new file mode 100644
index 0000000000..e83fa33e7d
--- /dev/null
+++ b/dts/doc/index.rst
@@ -0,0 +1,43 @@
+.. DPDK Test Suite documentation.
+
+Welcome to DPDK Test Suite's API documentation!
+===============================================
+
+.. automodule:: framework
+   :members:
+   :show-inheritance:
+
+Packages
+--------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 1
+
+   framework.testbed_model
+   framework.remote_session
+   framework.params
+   framework.config
+
+Modules
+-------
+
+.. toctree::
+   :maxdepth: 1
+
+   framework.runner
+   framework.test_suite
+   framework.test_result
+   framework.settings
+   framework.logger
+   framework.parser
+   framework.utils
+   framework.exception
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
-- 
2.34.1