[PATCH v2 1/4] dts: add tests package to API docs
Luca Vizzarro
luca.vizzarro at arm.com
Fri Nov 8 14:38:39 CET 2024
The test suites are not documented in the API as their respective
documentation files are missing.
Signed-off-by: Luca Vizzarro <luca.vizzarro at arm.com>
Reviewed-by: Paul Szczepanek <paul.szczepanek at arm.com>
---
doc/api/dts/index.rst | 1 +
doc/api/dts/tests.TestSuite_hello_world.rst | 9 +++++++++
doc/api/dts/tests.TestSuite_os_udp.rst | 9 +++++++++
.../tests.TestSuite_pmd_buffer_scatter.rst | 9 +++++++++
doc/api/dts/tests.TestSuite_smoke_tests.rst | 9 +++++++++
doc/api/dts/tests.TestSuite_vlan.rst | 10 ++++++++++
doc/api/dts/tests.rst | 19 +++++++++++++++++++
7 files changed, 66 insertions(+)
create mode 100644 doc/api/dts/tests.TestSuite_hello_world.rst
create mode 100644 doc/api/dts/tests.TestSuite_os_udp.rst
create mode 100644 doc/api/dts/tests.TestSuite_pmd_buffer_scatter.rst
create mode 100644 doc/api/dts/tests.TestSuite_smoke_tests.rst
create mode 100644 doc/api/dts/tests.TestSuite_vlan.rst
create mode 100644 doc/api/dts/tests.rst
diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst
index 534512dc17..db05fd37d5 100644
--- a/doc/api/dts/index.rst
+++ b/doc/api/dts/index.rst
@@ -14,6 +14,7 @@ Packages
:includehidden:
:maxdepth: 1
+ tests
framework.testbed_model
framework.remote_session
framework.params
diff --git a/doc/api/dts/tests.TestSuite_hello_world.rst b/doc/api/dts/tests.TestSuite_hello_world.rst
new file mode 100644
index 0000000000..f92786996f
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_hello_world.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+hello_world Test Suite
+======================
+
+.. automodule:: tests.TestSuite_hello_world
+ :members:
+ :show-inheritance:
+
diff --git a/doc/api/dts/tests.TestSuite_os_udp.rst b/doc/api/dts/tests.TestSuite_os_udp.rst
new file mode 100644
index 0000000000..121a653670
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_os_udp.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+os_udp Test Suite
+=================
+
+.. automodule:: tests.TestSuite_os_udp
+ :members:
+ :show-inheritance:
+
diff --git a/doc/api/dts/tests.TestSuite_pmd_buffer_scatter.rst b/doc/api/dts/tests.TestSuite_pmd_buffer_scatter.rst
new file mode 100644
index 0000000000..b6571b24f5
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_pmd_buffer_scatter.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+pmd_buffer_scatter Test Suite
+=============================
+
+.. automodule:: tests.TestSuite_pmd_buffer_scatter
+ :members:
+ :show-inheritance:
+
diff --git a/doc/api/dts/tests.TestSuite_smoke_tests.rst b/doc/api/dts/tests.TestSuite_smoke_tests.rst
new file mode 100644
index 0000000000..5b11aa7f48
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_smoke_tests.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+smoke_tests Test Suite
+======================
+
+.. automodule:: tests.TestSuite_smoke_tests
+ :members:
+ :show-inheritance:
+
diff --git a/doc/api/dts/tests.TestSuite_vlan.rst b/doc/api/dts/tests.TestSuite_vlan.rst
new file mode 100644
index 0000000000..86a29538bb
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_vlan.rst
@@ -0,0 +1,10 @@
+
+.. SPDX-License-Identifier: BSD-3-Clause
+
+vlan Test Suite
+===============
+
+.. automodule:: tests.TestSuite_vlan
+ :members:
+ :show-inheritance:
+
diff --git a/doc/api/dts/tests.rst b/doc/api/dts/tests.rst
new file mode 100644
index 0000000000..0c136b4bb0
--- /dev/null
+++ b/doc/api/dts/tests.rst
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+tests - Test Suites Package
+==============================
+
+.. automodule:: tests
+ :members:
+ :show-inheritance:
+
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+
+ tests.TestSuite_hello_world
+ tests.TestSuite_os_udp
+ tests.TestSuite_pmd_buffer_scatter
+ tests.TestSuite_smoke_tests
+ tests.TestSuite_vlan
+
--
2.43.0
More information about the dev
mailing list