From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id DC05E43928; Mon, 22 Jan 2024 13:01:05 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9746440ED2; Mon, 22 Jan 2024 13:00:54 +0100 (CET) Received: from mail-lf1-f52.google.com (mail-lf1-f52.google.com [209.85.167.52]) by mails.dpdk.org (Postfix) with ESMTP id B2F9040ECF for ; Mon, 22 Jan 2024 13:00:53 +0100 (CET) Received: by mail-lf1-f52.google.com with SMTP id 2adb3069b0e04-50e835800adso3227016e87.0 for ; Mon, 22 Jan 2024 04:00:53 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1705924853; x=1706529653; 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=nWbqoUhyYexWymYgN8zaZjXNGZEutO5nQ8s8xHIhNmY=; b=JcPa3qq1360SzX6ftAw1IKCJerOLsnf1sC2zKe2vOWXG20AvZOyW7gNfSYDJ5xk+PD yXy6mFVq8UEXpsycIRRmbDgAeyi9ANuHKxkPiq7Rgro5bx6MWIqTpdYfI+Ic3d0Z7YPw IBqKVRrwJdYtT6AKaxsAASCRzZFXbzBE37pow8VDObIq/EiteqUnBwdtAGginG3LegeY e1za7H53fWH3f7SejISfiisUES2plWkOyT6jhdDWicruie7lwg109fqqBMQre8MNq0gr cWxQ5Pann9Z3NZXenKvC+fzp5PY1NUUbi1v96m7ziJML18rIZ9WiFUX4G3ZphNpImQcw J7oQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705924853; x=1706529653; 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=nWbqoUhyYexWymYgN8zaZjXNGZEutO5nQ8s8xHIhNmY=; b=GqAOyBz8cy9Yob/evDXALCr82ZTVIfqdyfT/UdfRfCiIPYFe/10d/bQ1fBejdMSWEx Vh9r+jIMs0oU8jnuTKKr/DkPllcLE7X48eeRjR/mb8jZOnws32CHac2rFgPX6xhPhUfX Ya+YCbpMv2sqKGbQo4pdMPzpbKfbvanz0N5KzC4Mu5zzf3E/5nhxivcjFQyk676A4zS4 HRCbzveWan9tsSzYfoGlsZqKrLjj52PMssl5t94c9UsUXYEFWd+Xb6ivV7pmV9ddXLy2 TZxzlcJy2TT99ksMzj8BnsqyLId7X1D/cSEqrE/zrkSGMgizMKJJ8JXc6oKRYSqqu07W 2kZw== X-Gm-Message-State: AOJu0YyOJzEZxKFF9bpYkFmywVk5u9RUsPOAWecA9Le35A1OEiBw8PvG u7MyPO47rGdEKY68/OO+hHAzVMGht7BVCVTBaVAifkfrRCv86dTVGJHsucMsdYg= X-Google-Smtp-Source: AGHT+IGVxdpK838v6R20r31lvarlJtWG20WH27Ng7ayOAXgolVeKxQ3Mj8gSSdPV1AFUI0BJ3QDQUA== X-Received: by 2002:a19:9154:0:b0:50e:76eb:b984 with SMTP id y20-20020a199154000000b0050e76ebb984mr1002197lfj.14.1705924852994; Mon, 22 Jan 2024 04:00:52 -0800 (PST) Received: from localhost.localdomain ([84.245.120.159]) by smtp.gmail.com with ESMTPSA id x15-20020a170906298f00b00a27e4d34455sm13191550eje.183.2024.01.22.04.00.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 22 Jan 2024 04:00:52 -0800 (PST) From: =?UTF-8?q?Juraj=20Linke=C5=A1?= To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com, yoan.picchi@foss.arm.com, Luca.Vizzarro@arm.com Cc: dev@dpdk.org, =?UTF-8?q?Juraj=20Linke=C5=A1?= Subject: [PATCH v2 2/3] dts: add API doc sources Date: Mon, 22 Jan 2024 13:00:46 +0100 Message-Id: <20240122120047.16447-3-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240122120047.16447-1-juraj.linkes@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240122120047.16447-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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-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. 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 config options in mind. Signed-off-by: Juraj Linkeš --- dts/doc/conf_yaml_schema.json | 1 + dts/doc/framework.config.rst | 12 ++++++ dts/doc/framework.config.types.rst | 6 +++ dts/doc/framework.dts.rst | 6 +++ dts/doc/framework.exception.rst | 6 +++ dts/doc/framework.logger.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 | 17 ++++++++ .../framework.remote_session.ssh_session.rst | 6 +++ ...framework.remote_session.testpmd_shell.rst | 6 +++ dts/doc/framework.rst | 30 ++++++++++++++ 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 | 41 +++++++++++++++++++ 33 files changed, 297 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.dts.rst create mode 100644 dts/doc/framework.exception.rst create mode 100644 dts/doc/framework.logger.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.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..5af915b681 --- /dev/null +++ b/dts/doc/framework.config.types.rst @@ -0,0 +1,6 @@ +types - Configuration Types +=========================== + +.. automodule:: framework.config.types + :members: + :show-inheritance: diff --git a/dts/doc/framework.dts.rst b/dts/doc/framework.dts.rst new file mode 100644 index 0000000000..b1de438887 --- /dev/null +++ b/dts/doc/framework.dts.rst @@ -0,0 +1,6 @@ +dts - Testbed Setup and Test Suite Runner +========================================= + +.. automodule:: framework.dts + :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.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..74f83f0307 --- /dev/null +++ b/dts/doc/framework.remote_session.rst @@ -0,0 +1,17 @@ +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.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.rst b/dts/doc/framework.rst new file mode 100644 index 0000000000..978d5b5e38 --- /dev/null +++ b/dts/doc/framework.rst @@ -0,0 +1,30 @@ +framework - DTS Libraries +========================= + +.. automodule:: framework + :members: + :show-inheritance: + +Packages +-------- + +.. toctree:: + :maxdepth: 3 + + framework.config + framework.remote_session + framework.testbed_model + +Modules +------- + +.. toctree:: + :maxdepth: 1 + + framework.dts + framework.exception + framework.logger + framework.settings + framework.test_result + framework.test_suite + framework.utils 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..41206c000b --- /dev/null +++ b/dts/doc/framework.testbed_model.tg_node.rst @@ -0,0 +1,6 @@ +tg\_node - Traffig 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..fc3b6d78b9 --- /dev/null +++ b/dts/doc/index.rst @@ -0,0 +1,41 @@ +.. DPDK Test Suite documentation. + +Welcome to DPDK Test Suite's API documentation! +=============================================== + +.. automodule:: framework + :members: + :show-inheritance: + +Packages +-------- + +.. toctree:: + :includehidden: + :maxdepth: 1 + + framework.config + framework.remote_session + framework.testbed_model + +Modules +------- + +.. toctree:: + :maxdepth: 1 + + framework.dts + framework.exception + framework.logger + framework.settings + framework.test_result + framework.test_suite + framework.utils + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` -- 2.34.1