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 87A0F45822; Tue, 20 Aug 2024 15:19:04 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0F2C440DD8; Tue, 20 Aug 2024 15:18:31 +0200 (CEST) Received: from mail-ed1-f49.google.com (mail-ed1-f49.google.com [209.85.208.49]) by mails.dpdk.org (Postfix) with ESMTP id AA4BB40B9C for <dev@dpdk.org>; Tue, 20 Aug 2024 15:18:27 +0200 (CEST) Received: by mail-ed1-f49.google.com with SMTP id 4fb4d7f45d1cf-5a108354819so7164930a12.0 for <dev@dpdk.org>; Tue, 20 Aug 2024 06:18:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1724159907; x=1724764707; 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=6HvwsxM01bQ3jfC7mMjVjdjE2zCzMpPfkQenbwM4NsY=; b=GNx0jF/CMOW8gWQm7gb69uTq5t2Kx6O2OzmVa01wFXOqTQ29ckVX989ueoA2NCmtHF V3ENdOuNQXjlfLSFZbqF7WUlVwmSwcDCy++VCBuCM8jD3WJf/Cm15hUzOElqHEkxXhbU dW+zP1bbEQSgtmAhm8VRF4KrevRURo2QACY94v+hAvVNdjY26Tf6PPainl/C5+lT563O 0cJlLvyfuZ+30GsL8zY7yFcNwyPfNLUCQjOnucLWGQY4qmVQFtoSlqOvBY0KE/gj1Qs+ PWJXWWYhntX+uL/LDXgiGYXQ7JWRyzQnOTYaSIsrnoTyI6VD+x73GwlxHf5puNkrqL8e KP8Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724159907; x=1724764707; 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=6HvwsxM01bQ3jfC7mMjVjdjE2zCzMpPfkQenbwM4NsY=; b=HJcXFr5qxAFh5PPKGgA4ov3Tvl63qItCRT5oKIhC33p+FGV8G0t+w3tdwieeft5HQE Ror1C6ObvEAmsg+3ZTfP1w1Uk02UV92jpvGMe38Oh9h+YZ1CNawVZEalYQIFAt70Zc7y FUEYIeuNlr7xmk2TK25Y434ekKXAV0XdIXgt7Cn08/haVg3GU5fUsbIgD8m4NWc3F1n0 4hw8ioRKJraEvD1r+oCbz81ZvC5RLx0dD8GctANig4Q5O7ukRR5Whn2fv+K6Fdi+BIc5 ZihPebnXi5eVGmC4LZjb7bImNmFmV4IBWMlLdq5C2XdjMcA84+L3lGRZvJlUGag0ddS1 yVUQ== X-Gm-Message-State: AOJu0Yxys/uVAzgCehNuVwvM3C8pvpObmh0VXpIxa90cLv7wjA3qWPIf 9Drgp87PM918SI4BnSAuNqAhnm3duxvfUkzkgElU3r8bQ4ATyowOLWjW877M4wE= X-Google-Smtp-Source: AGHT+IH5j0M25LGh6FlTslhvtqqrdFw0QpVjef4WoDwGgMZMT7Sz/GaaEVj6zqyxqXO2IJrUOQSU9w== X-Received: by 2002:a05:6402:2749:b0:5bb:9ae0:4a48 with SMTP id 4fb4d7f45d1cf-5beca4e1d0bmr8583708a12.5.1724159907003; Tue, 20 Aug 2024 06:18:27 -0700 (PDT) Received: from jlinkes-PT-Latitude-5530.pantheon.local ([84.245.121.236]) by smtp.gmail.com with ESMTPSA id 4fb4d7f45d1cf-5bebbdfb7aasm6779073a12.51.2024.08.20.06.18.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 20 Aug 2024 06:18:26 -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 v18 4/5] dts: add API doc sources Date: Tue, 20 Aug 2024 15:18:18 +0200 Message-Id: <20240820131819.242016-5-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240820131819.242016-1-juraj.linkes@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240820131819.242016-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> --- doc/api/dts/conf_yaml_schema.json | 1 + doc/api/dts/framework.config.rst | 12 ++++++ doc/api/dts/framework.config.types.rst | 6 +++ doc/api/dts/framework.exception.rst | 6 +++ doc/api/dts/framework.logger.rst | 6 +++ doc/api/dts/framework.params.eal.rst | 6 +++ doc/api/dts/framework.params.rst | 14 ++++++ doc/api/dts/framework.params.testpmd.rst | 6 +++ doc/api/dts/framework.params.types.rst | 6 +++ doc/api/dts/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 +++ doc/api/dts/framework.remote_session.rst | 18 ++++++++ .../framework.remote_session.ssh_session.rst | 6 +++ ...framework.remote_session.testpmd_shell.rst | 6 +++ doc/api/dts/framework.runner.rst | 6 +++ doc/api/dts/framework.settings.rst | 6 +++ doc/api/dts/framework.test_result.rst | 6 +++ doc/api/dts/framework.test_suite.rst | 6 +++ doc/api/dts/framework.testbed_model.cpu.rst | 6 +++ .../framework.testbed_model.linux_session.rst | 6 +++ doc/api/dts/framework.testbed_model.node.rst | 6 +++ .../framework.testbed_model.os_session.rst | 6 +++ doc/api/dts/framework.testbed_model.port.rst | 6 +++ .../framework.testbed_model.posix_session.rst | 6 +++ doc/api/dts/framework.testbed_model.rst | 26 +++++++++++ .../dts/framework.testbed_model.sut_node.rst | 6 +++ .../dts/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 +++ doc/api/dts/framework.utils.rst | 6 +++ doc/api/dts/index.rst | 43 +++++++++++++++++++ 38 files changed, 314 insertions(+) create mode 120000 doc/api/dts/conf_yaml_schema.json create mode 100644 doc/api/dts/framework.config.rst create mode 100644 doc/api/dts/framework.config.types.rst create mode 100644 doc/api/dts/framework.exception.rst create mode 100644 doc/api/dts/framework.logger.rst create mode 100644 doc/api/dts/framework.params.eal.rst create mode 100644 doc/api/dts/framework.params.rst create mode 100644 doc/api/dts/framework.params.testpmd.rst create mode 100644 doc/api/dts/framework.params.types.rst create mode 100644 doc/api/dts/framework.parser.rst create mode 100644 doc/api/dts/framework.remote_session.dpdk_shell.rst create mode 100644 doc/api/dts/framework.remote_session.interactive_remote_session.rst create mode 100644 doc/api/dts/framework.remote_session.interactive_shell.rst create mode 100644 doc/api/dts/framework.remote_session.python_shell.rst create mode 100644 doc/api/dts/framework.remote_session.remote_session.rst create mode 100644 doc/api/dts/framework.remote_session.rst create mode 100644 doc/api/dts/framework.remote_session.ssh_session.rst create mode 100644 doc/api/dts/framework.remote_session.testpmd_shell.rst create mode 100644 doc/api/dts/framework.runner.rst create mode 100644 doc/api/dts/framework.settings.rst create mode 100644 doc/api/dts/framework.test_result.rst create mode 100644 doc/api/dts/framework.test_suite.rst create mode 100644 doc/api/dts/framework.testbed_model.cpu.rst create mode 100644 doc/api/dts/framework.testbed_model.linux_session.rst create mode 100644 doc/api/dts/framework.testbed_model.node.rst create mode 100644 doc/api/dts/framework.testbed_model.os_session.rst create mode 100644 doc/api/dts/framework.testbed_model.port.rst create mode 100644 doc/api/dts/framework.testbed_model.posix_session.rst create mode 100644 doc/api/dts/framework.testbed_model.rst create mode 100644 doc/api/dts/framework.testbed_model.sut_node.rst create mode 100644 doc/api/dts/framework.testbed_model.tg_node.rst create mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst create mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.rst create mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst create mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst create mode 100644 doc/api/dts/framework.testbed_model.virtual_device.rst create mode 100644 doc/api/dts/framework.utils.rst create mode 100644 doc/api/dts/index.rst diff --git a/doc/api/dts/conf_yaml_schema.json b/doc/api/dts/conf_yaml_schema.json new file mode 120000 index 0000000000..5978642d76 --- /dev/null +++ b/doc/api/dts/conf_yaml_schema.json @@ -0,0 +1 @@ +../../../dts/framework/config/conf_yaml_schema.json \ No newline at end of file diff --git a/doc/api/dts/framework.config.rst b/doc/api/dts/framework.config.rst new file mode 100644 index 0000000000..f765ef0e32 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.config.types.rst b/doc/api/dts/framework.config.types.rst new file mode 100644 index 0000000000..ed52bf5d3e --- /dev/null +++ b/doc/api/dts/framework.config.types.rst @@ -0,0 +1,6 @@ +config.types - Configuration Types +================================== + +.. automodule:: framework.config.types + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.exception.rst b/doc/api/dts/framework.exception.rst new file mode 100644 index 0000000000..ad58bd15de --- /dev/null +++ b/doc/api/dts/framework.exception.rst @@ -0,0 +1,6 @@ +exception - Exceptions +====================== + +.. automodule:: framework.exception + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.logger.rst b/doc/api/dts/framework.logger.rst new file mode 100644 index 0000000000..3c25b34819 --- /dev/null +++ b/doc/api/dts/framework.logger.rst @@ -0,0 +1,6 @@ +logger - Logging Facility +========================= + +.. automodule:: framework.logger + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.params.eal.rst b/doc/api/dts/framework.params.eal.rst new file mode 100644 index 0000000000..3908f6d471 --- /dev/null +++ b/doc/api/dts/framework.params.eal.rst @@ -0,0 +1,6 @@ +eal - EAL Parameters Modelling +============================== + +.. automodule:: framework.params.eal + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.params.rst b/doc/api/dts/framework.params.rst new file mode 100644 index 0000000000..a273b6378a --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.params.testpmd.rst b/doc/api/dts/framework.params.testpmd.rst new file mode 100644 index 0000000000..5f25ed5528 --- /dev/null +++ b/doc/api/dts/framework.params.testpmd.rst @@ -0,0 +1,6 @@ +testpmd - TestPMD Parameters Modelling +====================================== + +.. automodule:: framework.params.testpmd + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.params.types.rst b/doc/api/dts/framework.params.types.rst new file mode 100644 index 0000000000..9c68a7fab8 --- /dev/null +++ b/doc/api/dts/framework.params.types.rst @@ -0,0 +1,6 @@ +params.types - Parameters Modelling Types +========================================= + +.. automodule:: framework.params.types + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.parser.rst b/doc/api/dts/framework.parser.rst new file mode 100644 index 0000000000..a5e3264f35 --- /dev/null +++ b/doc/api/dts/framework.parser.rst @@ -0,0 +1,6 @@ +parser - Text Parsing Utilities +=============================== + +.. automodule:: framework.parser + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.remote_session.dpdk_shell.rst b/doc/api/dts/framework.remote_session.dpdk_shell.rst new file mode 100644 index 0000000000..4402eba4fd --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.remote_session.interactive_remote_session.rst b/doc/api/dts/framework.remote_session.interactive_remote_session.rst new file mode 100644 index 0000000000..35dc5c4b03 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.remote_session.interactive_shell.rst b/doc/api/dts/framework.remote_session.interactive_shell.rst new file mode 100644 index 0000000000..8a59db7b6e --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.remote_session.python_shell.rst b/doc/api/dts/framework.remote_session.python_shell.rst new file mode 100644 index 0000000000..a8ec06f281 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.remote_session.remote_session.rst b/doc/api/dts/framework.remote_session.remote_session.rst new file mode 100644 index 0000000000..58b0960d07 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.remote_session.rst b/doc/api/dts/framework.remote_session.rst new file mode 100644 index 0000000000..4e755b1fe3 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.remote_session.ssh_session.rst b/doc/api/dts/framework.remote_session.ssh_session.rst new file mode 100644 index 0000000000..05b019bc7c --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.remote_session.testpmd_shell.rst b/doc/api/dts/framework.remote_session.testpmd_shell.rst new file mode 100644 index 0000000000..14510afb2b --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.runner.rst b/doc/api/dts/framework.runner.rst new file mode 100644 index 0000000000..a1708f0002 --- /dev/null +++ b/doc/api/dts/framework.runner.rst @@ -0,0 +1,6 @@ +runner - Testbed Setup and Test Suite Runner +============================================ + +.. automodule:: framework.runner + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.settings.rst b/doc/api/dts/framework.settings.rst new file mode 100644 index 0000000000..96bf194923 --- /dev/null +++ b/doc/api/dts/framework.settings.rst @@ -0,0 +1,6 @@ +settings - Command Line Arguments and Environment Variables +=========================================================== + +.. automodule:: framework.settings + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.test_result.rst b/doc/api/dts/framework.test_result.rst new file mode 100644 index 0000000000..527357a04a --- /dev/null +++ b/doc/api/dts/framework.test_result.rst @@ -0,0 +1,6 @@ +test\_result - Test Results Records +=================================== + +.. automodule:: framework.test_result + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.test_suite.rst b/doc/api/dts/framework.test_suite.rst new file mode 100644 index 0000000000..96f893e465 --- /dev/null +++ b/doc/api/dts/framework.test_suite.rst @@ -0,0 +1,6 @@ +test\_suite - Common Test Suite Features +======================================== + +.. automodule:: framework.test_suite + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.cpu.rst b/doc/api/dts/framework.testbed_model.cpu.rst new file mode 100644 index 0000000000..dd2baf09fb --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.linux_session.rst b/doc/api/dts/framework.testbed_model.linux_session.rst new file mode 100644 index 0000000000..141f3f49e3 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.node.rst b/doc/api/dts/framework.testbed_model.node.rst new file mode 100644 index 0000000000..2133dd604b --- /dev/null +++ b/doc/api/dts/framework.testbed_model.node.rst @@ -0,0 +1,6 @@ +node - Base Node +================ + +.. automodule:: framework.testbed_model.node + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.os_session.rst b/doc/api/dts/framework.testbed_model.os_session.rst new file mode 100644 index 0000000000..f3574e939a --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.port.rst b/doc/api/dts/framework.testbed_model.port.rst new file mode 100644 index 0000000000..17bd391e63 --- /dev/null +++ b/doc/api/dts/framework.testbed_model.port.rst @@ -0,0 +1,6 @@ +port - NIC Port Representation +============================== + +.. automodule:: framework.testbed_model.port + :members: + :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.posix_session.rst b/doc/api/dts/framework.testbed_model.posix_session.rst new file mode 100644 index 0000000000..308c051ae5 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.rst b/doc/api/dts/framework.testbed_model.rst new file mode 100644 index 0000000000..4b024e47e6 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.sut_node.rst b/doc/api/dts/framework.testbed_model.sut_node.rst new file mode 100644 index 0000000000..7e12b6c87e --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.tg_node.rst b/doc/api/dts/framework.testbed_model.tg_node.rst new file mode 100644 index 0000000000..e56db8e782 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst b/doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst new file mode 100644 index 0000000000..06c087155a --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.traffic_generator.rst b/doc/api/dts/framework.testbed_model.traffic_generator.rst new file mode 100644 index 0000000000..18b6f1b98b --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst b/doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst new file mode 100644 index 0000000000..7062914ec3 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst b/doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst new file mode 100644 index 0000000000..e366d7f222 --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.testbed_model.virtual_device.rst b/doc/api/dts/framework.testbed_model.virtual_device.rst new file mode 100644 index 0000000000..38e6c1d0bc --- /dev/null +++ b/doc/api/dts/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/doc/api/dts/framework.utils.rst b/doc/api/dts/framework.utils.rst new file mode 100644 index 0000000000..0e7bb80666 --- /dev/null +++ b/doc/api/dts/framework.utils.rst @@ -0,0 +1,6 @@ +utils - Various Utilities +========================= + +.. automodule:: framework.utils + :members: + :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst new file mode 100644 index 0000000000..e83fa33e7d --- /dev/null +++ b/doc/api/dts/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