Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/139235/?format=api
{ "id": 139235, "url": "http://patches.dpdk.org/api/patches/139235/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20240412101405.94377-3-juraj.linkes@pantheon.tech/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20240412101405.94377-3-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20240412101405.94377-3-juraj.linkes@pantheon.tech", "date": "2024-04-12T10:14:04", "name": "[v4,2/3] dts: add API doc sources", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "10aceb67242758a4341c162374704be7af84d728", "submitter": { "id": 1626, "url": "http://patches.dpdk.org/api/people/1626/?format=api", "name": "Juraj Linkeš", "email": "juraj.linkes@pantheon.tech" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20240412101405.94377-3-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 31728, "url": "http://patches.dpdk.org/api/series/31728/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=31728", "date": "2024-04-12T10:14:02", "name": "dts: API docs generation", "version": 4, "mbox": "http://patches.dpdk.org/series/31728/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/139235/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/139235/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id C799743E51;\n\tFri, 12 Apr 2024 12:14:25 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id DECCB40A71;\n\tFri, 12 Apr 2024 12:14:13 +0200 (CEST)", "from mail-ej1-f47.google.com (mail-ej1-f47.google.com\n [209.85.218.47]) by mails.dpdk.org (Postfix) with ESMTP id 1826A4064C\n for <dev@dpdk.org>; Fri, 12 Apr 2024 12:14:11 +0200 (CEST)", "by mail-ej1-f47.google.com with SMTP id\n a640c23a62f3a-a523f89212cso3388866b.1\n for <dev@dpdk.org>; Fri, 12 Apr 2024 03:14:10 -0700 (PDT)", "from jlinkes-PT-Latitude-5530.pantheon.local ([84.245.121.75])\n by smtp.gmail.com with ESMTPSA id\n k11-20020a170906578b00b00a51be2b75f3sm1640802ejq.35.2024.04.12.03.14.09\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Fri, 12 Apr 2024 03:14:09 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon.tech; s=google; t=1712916851; x=1713521651; darn=dpdk.org;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:from:to:cc:subject:date\n :message-id:reply-to;\n bh=9E1X0wEejEqRWjQy2mUsnwuBCVAHWZxouPKwLF/fjkY=;\n b=NrbexbnopjYNB9G3Lln518jrs2gVMG1ZfcVkekKciVewEENEPHVzlymO6tZTNBUaq7\n weXB4wgJboE6Sc74aFEu7OGsEYAxOQ804moFrxcws5pTB8YM9P6pAzTpc3cHf8Ci/Dy5\n emZV/UU7tzpO8yGSKLApuF0Y7kBJbokLizeJkkDJQsjU15jwZmfp8Wwa09MV8qUw0uEg\n 4mDza8BfpgtMa+tobDJ3h7cwyoC8fJc/hwtAGaMM4NX5M2+sqEJYYvp49uCjdE1AHMbx\n KXmZmlbK3j8EkESyBynFUHp8woZKaIVEAumZFdxxaN2sBZ6Bsieziv3ydKh+qUQpxkhr\n CNXw==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1712916851; x=1713521651;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=9E1X0wEejEqRWjQy2mUsnwuBCVAHWZxouPKwLF/fjkY=;\n b=nbBXRkYFThIe6FqBYZ84STuthnNAuUWEHMYyrvKe7PK+E/HUJ61CqbFym+QuT6Ihl/\n 8uXJlVA9ZYD9CbKzzra23H5B7rlV3n1PitGnIBxbyCx/DL2MQJlql0/wY6VakjX5K8B0\n ldNCAqkTdQrR0752Cpjy6Ef6JXLF1z+n5qDkR39ck9LNT6CA6fTN2XcZwugXOKPNDkz1\n n7IB2xKyGPQ+51wl9nV/mtD+SvVsno7bLfStynDoQEV1fPfTXLMPsAArdCflc99JHcqU\n Kf8o9eXOZl7HDsMbv4Krb9Zy9201qeC23IPU5TPsrld8COG/FSR7m8S23vKYwtqr4Scq\n yj/w==", "X-Gm-Message-State": "AOJu0YwEvtgXFWSeWgC6meJIaxQeKUzu8+buU0Zh1D7MuhzXVGjku2vZ\n 1TBYluqbTmfFUcZ9c9DnnAi7rotAoC9q5JzvksNLkPMK2jtmLJFSp74Ea7TkTO8=", "X-Google-Smtp-Source": "\n AGHT+IGFgO7YTs9IYr4/aIsRerntnoWmE1mCX+v45K2ol98FDW5uoqpED/mUnZQBglYfaUrkQcn10Q==", "X-Received": "by 2002:a17:906:11cd:b0:a51:adac:e1dd with SMTP id\n o13-20020a17090611cd00b00a51adace1ddmr1540091eja.26.1712916850685;\n Fri, 12 Apr 2024 03:14:10 -0700 (PDT)", "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "To": "thomas@monjalon.net, Honnappa.Nagarahalli@arm.com,\n bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu,\n paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[PATCH v4 2/3] dts: add API doc sources", "Date": "Fri, 12 Apr 2024 12:14:04 +0200", "Message-Id": "<20240412101405.94377-3-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240412101405.94377-1-juraj.linkes@pantheon.tech>", "References": "<20231115133606.42081-1-juraj.linkes@pantheon.tech>\n <20240412101405.94377-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>,\n <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>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "These sources could be generated with the sphinx-apidoc utility, but\nthat doesn't give us enough flexibility, such as sorting the order of\nmodules or changing the headers of the modules.\n\nThe sources included in this patch were in fact generated by said\nutility, but modified to improve the look of the documentation. The\nimprovements are mainly in toctree definitions and the titles of the\nmodules/packages. These were made with specific Sphinx config options in\nmind.\n\nSigned-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>\n---\n dts/doc/conf_yaml_schema.json | 1 +\n dts/doc/framework.config.rst | 12 ++++++\n dts/doc/framework.config.types.rst | 6 +++\n dts/doc/framework.exception.rst | 6 +++\n dts/doc/framework.logger.rst | 6 +++\n ...ote_session.interactive_remote_session.rst | 6 +++\n ...ework.remote_session.interactive_shell.rst | 6 +++\n .../framework.remote_session.python_shell.rst | 6 +++\n ...ramework.remote_session.remote_session.rst | 6 +++\n dts/doc/framework.remote_session.rst | 17 ++++++++\n .../framework.remote_session.ssh_session.rst | 6 +++\n ...framework.remote_session.testpmd_shell.rst | 6 +++\n dts/doc/framework.runner.rst | 6 +++\n dts/doc/framework.settings.rst | 6 +++\n dts/doc/framework.test_result.rst | 6 +++\n dts/doc/framework.test_suite.rst | 6 +++\n dts/doc/framework.testbed_model.cpu.rst | 6 +++\n .../framework.testbed_model.linux_session.rst | 6 +++\n dts/doc/framework.testbed_model.node.rst | 6 +++\n .../framework.testbed_model.os_session.rst | 6 +++\n dts/doc/framework.testbed_model.port.rst | 6 +++\n .../framework.testbed_model.posix_session.rst | 6 +++\n dts/doc/framework.testbed_model.rst | 26 ++++++++++++\n dts/doc/framework.testbed_model.sut_node.rst | 6 +++\n dts/doc/framework.testbed_model.tg_node.rst | 6 +++\n ..._generator.capturing_traffic_generator.rst | 6 +++\n ...mework.testbed_model.traffic_generator.rst | 14 +++++++\n ....testbed_model.traffic_generator.scapy.rst | 6 +++\n ...el.traffic_generator.traffic_generator.rst | 6 +++\n ...framework.testbed_model.virtual_device.rst | 6 +++\n dts/doc/framework.utils.rst | 6 +++\n dts/doc/index.rst | 41 +++++++++++++++++++\n 32 files changed, 267 insertions(+)\n create mode 120000 dts/doc/conf_yaml_schema.json\n create mode 100644 dts/doc/framework.config.rst\n create mode 100644 dts/doc/framework.config.types.rst\n create mode 100644 dts/doc/framework.exception.rst\n create mode 100644 dts/doc/framework.logger.rst\n create mode 100644 dts/doc/framework.remote_session.interactive_remote_session.rst\n create mode 100644 dts/doc/framework.remote_session.interactive_shell.rst\n create mode 100644 dts/doc/framework.remote_session.python_shell.rst\n create mode 100644 dts/doc/framework.remote_session.remote_session.rst\n create mode 100644 dts/doc/framework.remote_session.rst\n create mode 100644 dts/doc/framework.remote_session.ssh_session.rst\n create mode 100644 dts/doc/framework.remote_session.testpmd_shell.rst\n create mode 100644 dts/doc/framework.runner.rst\n create mode 100644 dts/doc/framework.settings.rst\n create mode 100644 dts/doc/framework.test_result.rst\n create mode 100644 dts/doc/framework.test_suite.rst\n create mode 100644 dts/doc/framework.testbed_model.cpu.rst\n create mode 100644 dts/doc/framework.testbed_model.linux_session.rst\n create mode 100644 dts/doc/framework.testbed_model.node.rst\n create mode 100644 dts/doc/framework.testbed_model.os_session.rst\n create mode 100644 dts/doc/framework.testbed_model.port.rst\n create mode 100644 dts/doc/framework.testbed_model.posix_session.rst\n create mode 100644 dts/doc/framework.testbed_model.rst\n create mode 100644 dts/doc/framework.testbed_model.sut_node.rst\n create mode 100644 dts/doc/framework.testbed_model.tg_node.rst\n create mode 100644 dts/doc/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst\n create mode 100644 dts/doc/framework.testbed_model.traffic_generator.rst\n create mode 100644 dts/doc/framework.testbed_model.traffic_generator.scapy.rst\n create mode 100644 dts/doc/framework.testbed_model.traffic_generator.traffic_generator.rst\n create mode 100644 dts/doc/framework.testbed_model.virtual_device.rst\n create mode 100644 dts/doc/framework.utils.rst\n create mode 100644 dts/doc/index.rst", "diff": "diff --git a/dts/doc/conf_yaml_schema.json b/dts/doc/conf_yaml_schema.json\nnew file mode 120000\nindex 0000000000..d89eb81b72\n--- /dev/null\n+++ b/dts/doc/conf_yaml_schema.json\n@@ -0,0 +1 @@\n+../framework/config/conf_yaml_schema.json\n\\ No newline at end of file\ndiff --git a/dts/doc/framework.config.rst b/dts/doc/framework.config.rst\nnew file mode 100644\nindex 0000000000..f765ef0e32\n--- /dev/null\n+++ b/dts/doc/framework.config.rst\n@@ -0,0 +1,12 @@\n+config - Configuration Package\n+==============================\n+\n+.. automodule:: framework.config\n+ :members:\n+ :show-inheritance:\n+\n+.. toctree::\n+ :hidden:\n+ :maxdepth: 1\n+\n+ framework.config.types\ndiff --git a/dts/doc/framework.config.types.rst b/dts/doc/framework.config.types.rst\nnew file mode 100644\nindex 0000000000..5af915b681\n--- /dev/null\n+++ b/dts/doc/framework.config.types.rst\n@@ -0,0 +1,6 @@\n+types - Configuration Types\n+===========================\n+\n+.. automodule:: framework.config.types\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.exception.rst b/dts/doc/framework.exception.rst\nnew file mode 100644\nindex 0000000000..ad58bd15de\n--- /dev/null\n+++ b/dts/doc/framework.exception.rst\n@@ -0,0 +1,6 @@\n+exception - Exceptions\n+======================\n+\n+.. automodule:: framework.exception\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.logger.rst b/dts/doc/framework.logger.rst\nnew file mode 100644\nindex 0000000000..3c25b34819\n--- /dev/null\n+++ b/dts/doc/framework.logger.rst\n@@ -0,0 +1,6 @@\n+logger - Logging Facility\n+=========================\n+\n+.. automodule:: framework.logger\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.remote_session.interactive_remote_session.rst b/dts/doc/framework.remote_session.interactive_remote_session.rst\nnew file mode 100644\nindex 0000000000..35dc5c4b03\n--- /dev/null\n+++ b/dts/doc/framework.remote_session.interactive_remote_session.rst\n@@ -0,0 +1,6 @@\n+interactive\\_remote\\_session - SSH Interactive Remote Session\n+=============================================================\n+\n+.. automodule:: framework.remote_session.interactive_remote_session\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.remote_session.interactive_shell.rst b/dts/doc/framework.remote_session.interactive_shell.rst\nnew file mode 100644\nindex 0000000000..8a59db7b6e\n--- /dev/null\n+++ b/dts/doc/framework.remote_session.interactive_shell.rst\n@@ -0,0 +1,6 @@\n+interactive\\_shell - Base Interactive Remote Shell\n+==================================================\n+\n+.. automodule:: framework.remote_session.interactive_shell\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.remote_session.python_shell.rst b/dts/doc/framework.remote_session.python_shell.rst\nnew file mode 100644\nindex 0000000000..a8ec06f281\n--- /dev/null\n+++ b/dts/doc/framework.remote_session.python_shell.rst\n@@ -0,0 +1,6 @@\n+python\\_shell - Python Interactive Remote Shell\n+===============================================\n+\n+.. automodule:: framework.remote_session.python_shell\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.remote_session.remote_session.rst b/dts/doc/framework.remote_session.remote_session.rst\nnew file mode 100644\nindex 0000000000..58b0960d07\n--- /dev/null\n+++ b/dts/doc/framework.remote_session.remote_session.rst\n@@ -0,0 +1,6 @@\n+remote\\_session - Remote Session ABC\n+====================================\n+\n+.. automodule:: framework.remote_session.remote_session\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.remote_session.rst b/dts/doc/framework.remote_session.rst\nnew file mode 100644\nindex 0000000000..74f83f0307\n--- /dev/null\n+++ b/dts/doc/framework.remote_session.rst\n@@ -0,0 +1,17 @@\n+remote\\_session - Node Connections Package\n+==========================================\n+\n+.. automodule:: framework.remote_session\n+ :members:\n+ :show-inheritance:\n+\n+.. toctree::\n+ :hidden:\n+ :maxdepth: 1\n+\n+ framework.remote_session.remote_session\n+ framework.remote_session.ssh_session\n+ framework.remote_session.interactive_remote_session\n+ framework.remote_session.interactive_shell\n+ framework.remote_session.testpmd_shell\n+ framework.remote_session.python_shell\ndiff --git a/dts/doc/framework.remote_session.ssh_session.rst b/dts/doc/framework.remote_session.ssh_session.rst\nnew file mode 100644\nindex 0000000000..05b019bc7c\n--- /dev/null\n+++ b/dts/doc/framework.remote_session.ssh_session.rst\n@@ -0,0 +1,6 @@\n+ssh\\_session - SSH Remote Session\n+=================================\n+\n+.. automodule:: framework.remote_session.ssh_session\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.remote_session.testpmd_shell.rst b/dts/doc/framework.remote_session.testpmd_shell.rst\nnew file mode 100644\nindex 0000000000..14510afb2b\n--- /dev/null\n+++ b/dts/doc/framework.remote_session.testpmd_shell.rst\n@@ -0,0 +1,6 @@\n+testpmd\\_shell - Testpmd Interactive Remote Shell\n+=================================================\n+\n+.. automodule:: framework.remote_session.testpmd_shell\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.runner.rst b/dts/doc/framework.runner.rst\nnew file mode 100644\nindex 0000000000..a1708f0002\n--- /dev/null\n+++ b/dts/doc/framework.runner.rst\n@@ -0,0 +1,6 @@\n+runner - Testbed Setup and Test Suite Runner\n+============================================\n+\n+.. automodule:: framework.runner\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.settings.rst b/dts/doc/framework.settings.rst\nnew file mode 100644\nindex 0000000000..96bf194923\n--- /dev/null\n+++ b/dts/doc/framework.settings.rst\n@@ -0,0 +1,6 @@\n+settings - Command Line Arguments and Environment Variables\n+===========================================================\n+\n+.. automodule:: framework.settings\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.test_result.rst b/dts/doc/framework.test_result.rst\nnew file mode 100644\nindex 0000000000..527357a04a\n--- /dev/null\n+++ b/dts/doc/framework.test_result.rst\n@@ -0,0 +1,6 @@\n+test\\_result - Test Results Records\n+===================================\n+\n+.. automodule:: framework.test_result\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.test_suite.rst b/dts/doc/framework.test_suite.rst\nnew file mode 100644\nindex 0000000000..96f893e465\n--- /dev/null\n+++ b/dts/doc/framework.test_suite.rst\n@@ -0,0 +1,6 @@\n+test\\_suite - Common Test Suite Features\n+========================================\n+\n+.. automodule:: framework.test_suite\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.cpu.rst b/dts/doc/framework.testbed_model.cpu.rst\nnew file mode 100644\nindex 0000000000..dd2baf09fb\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.cpu.rst\n@@ -0,0 +1,6 @@\n+cpu - CPU Representation and Utilities\n+======================================\n+\n+.. automodule:: framework.testbed_model.cpu\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.linux_session.rst b/dts/doc/framework.testbed_model.linux_session.rst\nnew file mode 100644\nindex 0000000000..141f3f49e3\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.linux_session.rst\n@@ -0,0 +1,6 @@\n+linux\\_session - Linux Remote Session\n+=====================================\n+\n+.. automodule:: framework.testbed_model.linux_session\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.node.rst b/dts/doc/framework.testbed_model.node.rst\nnew file mode 100644\nindex 0000000000..2133dd604b\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.node.rst\n@@ -0,0 +1,6 @@\n+node - Base Node\n+================\n+\n+.. automodule:: framework.testbed_model.node\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.os_session.rst b/dts/doc/framework.testbed_model.os_session.rst\nnew file mode 100644\nindex 0000000000..f3574e939a\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.os_session.rst\n@@ -0,0 +1,6 @@\n+os\\_session - OS-aware Remote Session ABC\n+=========================================\n+\n+.. automodule:: framework.testbed_model.os_session\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.port.rst b/dts/doc/framework.testbed_model.port.rst\nnew file mode 100644\nindex 0000000000..17bd391e63\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.port.rst\n@@ -0,0 +1,6 @@\n+port - NIC Port Representation\n+==============================\n+\n+.. automodule:: framework.testbed_model.port\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.posix_session.rst b/dts/doc/framework.testbed_model.posix_session.rst\nnew file mode 100644\nindex 0000000000..308c051ae5\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.posix_session.rst\n@@ -0,0 +1,6 @@\n+posix\\_session - Posix Remote Session\n+=====================================\n+\n+.. automodule:: framework.testbed_model.posix_session\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.rst b/dts/doc/framework.testbed_model.rst\nnew file mode 100644\nindex 0000000000..4b024e47e6\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.rst\n@@ -0,0 +1,26 @@\n+testbed\\_model - Testbed Modelling Package\n+==========================================\n+\n+.. automodule:: framework.testbed_model\n+ :members:\n+ :show-inheritance:\n+\n+.. toctree::\n+ :hidden:\n+ :maxdepth: 2\n+\n+ framework.testbed_model.traffic_generator\n+\n+.. toctree::\n+ :hidden:\n+ :maxdepth: 1\n+\n+ framework.testbed_model.os_session\n+ framework.testbed_model.linux_session\n+ framework.testbed_model.posix_session\n+ framework.testbed_model.node\n+ framework.testbed_model.sut_node\n+ framework.testbed_model.tg_node\n+ framework.testbed_model.cpu\n+ framework.testbed_model.port\n+ framework.testbed_model.virtual_device\ndiff --git a/dts/doc/framework.testbed_model.sut_node.rst b/dts/doc/framework.testbed_model.sut_node.rst\nnew file mode 100644\nindex 0000000000..7e12b6c87e\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.sut_node.rst\n@@ -0,0 +1,6 @@\n+sut\\_node - System Under Test Node\n+==================================\n+\n+.. automodule:: framework.testbed_model.sut_node\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.tg_node.rst b/dts/doc/framework.testbed_model.tg_node.rst\nnew file mode 100644\nindex 0000000000..41206c000b\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.tg_node.rst\n@@ -0,0 +1,6 @@\n+tg\\_node - Traffig Generator Node\n+=================================\n+\n+.. automodule:: framework.testbed_model.tg_node\n+ :members:\n+ :show-inheritance:\ndiff --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\nnew file mode 100644\nindex 0000000000..06c087155a\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst\n@@ -0,0 +1,6 @@\n+capturing\\_traffic\\_generator - Base Capturing TG ABC\n+=====================================================\n+\n+.. automodule:: framework.testbed_model.traffic_generator.capturing_traffic_generator\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.traffic_generator.rst b/dts/doc/framework.testbed_model.traffic_generator.rst\nnew file mode 100644\nindex 0000000000..18b6f1b98b\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.traffic_generator.rst\n@@ -0,0 +1,14 @@\n+traffic\\_generator Subpackage\n+=============================\n+\n+.. automodule:: framework.testbed_model.traffic_generator\n+ :members:\n+ :show-inheritance:\n+\n+.. toctree::\n+ :hidden:\n+ :maxdepth: 1\n+\n+ framework.testbed_model.traffic_generator.traffic_generator\n+ framework.testbed_model.traffic_generator.capturing_traffic_generator\n+ framework.testbed_model.traffic_generator.scapy\ndiff --git a/dts/doc/framework.testbed_model.traffic_generator.scapy.rst b/dts/doc/framework.testbed_model.traffic_generator.scapy.rst\nnew file mode 100644\nindex 0000000000..7062914ec3\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.traffic_generator.scapy.rst\n@@ -0,0 +1,6 @@\n+scapy - Capturing Traffic Generator\n+===================================\n+\n+.. automodule:: framework.testbed_model.traffic_generator.scapy\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.traffic_generator.traffic_generator.rst b/dts/doc/framework.testbed_model.traffic_generator.traffic_generator.rst\nnew file mode 100644\nindex 0000000000..e366d7f222\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.traffic_generator.traffic_generator.rst\n@@ -0,0 +1,6 @@\n+traffic\\_generator - Base TG ABC\n+================================\n+\n+.. automodule:: framework.testbed_model.traffic_generator.traffic_generator\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.testbed_model.virtual_device.rst b/dts/doc/framework.testbed_model.virtual_device.rst\nnew file mode 100644\nindex 0000000000..38e6c1d0bc\n--- /dev/null\n+++ b/dts/doc/framework.testbed_model.virtual_device.rst\n@@ -0,0 +1,6 @@\n+virtual\\_device - Virtual Devices\n+=================================\n+\n+.. automodule:: framework.testbed_model.virtual_device\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/framework.utils.rst b/dts/doc/framework.utils.rst\nnew file mode 100644\nindex 0000000000..0e7bb80666\n--- /dev/null\n+++ b/dts/doc/framework.utils.rst\n@@ -0,0 +1,6 @@\n+utils - Various Utilities\n+=========================\n+\n+.. automodule:: framework.utils\n+ :members:\n+ :show-inheritance:\ndiff --git a/dts/doc/index.rst b/dts/doc/index.rst\nnew file mode 100644\nindex 0000000000..501e7204a7\n--- /dev/null\n+++ b/dts/doc/index.rst\n@@ -0,0 +1,41 @@\n+.. DPDK Test Suite documentation.\n+\n+Welcome to DPDK Test Suite's API documentation!\n+===============================================\n+\n+.. automodule:: framework\n+ :members:\n+ :show-inheritance:\n+\n+Packages\n+--------\n+\n+.. toctree::\n+ :includehidden:\n+ :maxdepth: 1\n+\n+ framework.testbed_model\n+ framework.remote_session\n+ framework.config\n+\n+Modules\n+-------\n+\n+.. toctree::\n+ :maxdepth: 1\n+\n+ framework.runner\n+ framework.test_suite\n+ framework.test_result\n+ framework.settings\n+ framework.logger\n+ framework.utils\n+ framework.exception\n+\n+\n+Indices and tables\n+==================\n+\n+* :ref:`genindex`\n+* :ref:`modindex`\n+* :ref:`search`\n", "prefixes": [ "v4", "2/3" ] }