diff mbox series

[v3,10/12] doc: add DTS capability doc sources

Message ID 20240821145315.97974-11-juraj.linkes@pantheon.tech (mailing list archive)
State Superseded
Delegated to: Juraj Linkeš
Headers
Series dts: add test skipping based on capabilities |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Juraj Linkeš Aug. 21, 2024, 2:53 p.m. UTC 
Add new files to generate DTS API documentation from.

Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
---
 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

Jeremy Spewock Aug. 26, 2024, 5:13 p.m. UTC | #1 
On Wed, Aug 21, 2024 at 10:53 AM Juraj Linkeš
<juraj.linkes@pantheon.tech> wrote:
>
> 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>
Dean Marx Sept. 3, 2024, 5:52 p.m. UTC | #2 
On Wed, Aug 21, 2024 at 10:53 AM Juraj Linkeš <juraj.linkes@pantheon.tech>
wrote:

> Add new files to generate DTS API documentation from.
>
> Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
>

Reviewed-by: Dean Marx <dmarx@iol.unh.edu>
diff mbox series

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: