[v4,09/11] doc: add DTS capability doc sources

Message ID 20240923150210.57269-9-juraj.linkes@pantheon.tech (mailing list archive)
State Accepted
Delegated to: Juraj Linkeš
Headers
Series [v4,01/11] dts: add the aenum dependency |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Juraj Linkeš Sept. 23, 2024, 3:02 p.m. UTC
Add new files to generate DTS API documentation from.

Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
Reviewed-by: Jeremy Spewock <jspewock@iol.unh.edu>
Reviewed-by: Dean Marx <dmarx@iol.unh.edu>
---
 doc/api/dts/framework.testbed_model.capability.rst | 6 ++++++
 doc/api/dts/framework.testbed_model.rst            | 2 ++
 doc/api/dts/framework.testbed_model.topology.rst   | 6 ++++++
 3 files changed, 14 insertions(+)
 create mode 100644 doc/api/dts/framework.testbed_model.capability.rst
 create mode 100644 doc/api/dts/framework.testbed_model.topology.rst
  

Comments

Luca Vizzarro Sept. 27, 2024, 1:04 p.m. UTC | #1
Reviewed-by: Luca Vizzarro <luca.vizzarro@arm.com>
  

Patch

diff --git a/doc/api/dts/framework.testbed_model.capability.rst b/doc/api/dts/framework.testbed_model.capability.rst
new file mode 100644
index 0000000000..326fed9104
--- /dev/null
+++ b/doc/api/dts/framework.testbed_model.capability.rst
@@ -0,0 +1,6 @@ 
+capability - Testbed Capabilities
+=================================
+
+.. automodule:: framework.testbed_model.capability
+   :members:
+   :show-inheritance:
diff --git a/doc/api/dts/framework.testbed_model.rst b/doc/api/dts/framework.testbed_model.rst
index 4b024e47e6..e1f9543b28 100644
--- a/doc/api/dts/framework.testbed_model.rst
+++ b/doc/api/dts/framework.testbed_model.rst
@@ -21,6 +21,8 @@  testbed\_model - Testbed Modelling Package
    framework.testbed_model.node
    framework.testbed_model.sut_node
    framework.testbed_model.tg_node
+   framework.testbed_model.capability
    framework.testbed_model.cpu
    framework.testbed_model.port
+   framework.testbed_model.topology
    framework.testbed_model.virtual_device
diff --git a/doc/api/dts/framework.testbed_model.topology.rst b/doc/api/dts/framework.testbed_model.topology.rst
new file mode 100644
index 0000000000..f3d9d1f418
--- /dev/null
+++ b/doc/api/dts/framework.testbed_model.topology.rst
@@ -0,0 +1,6 @@ 
+topology - Testbed Topology
+===========================
+
+.. automodule:: framework.testbed_model.topology
+   :members:
+   :show-inheritance: