Skip to content

Commit

Permalink
samples: net: openthread: create category in docs
Browse files Browse the repository at this point in the history
Add higher-level category for OpenThread in docs to avoid orphaned
sample documentation.

Signed-off-by: Martin Jäger <martin@libre.solar>
  • Loading branch information
martinjaeger authored and kartben committed Jan 3, 2025
1 parent 8eff862 commit 17cde7d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/connectivity/usb/device/usb_device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ CDC ACM UART as backend for a subsystem or application:
* ``zephyr,bt-c2h-uart`` used in Bluetooth,
for example see :zephyr:code-sample:`bluetooth_hci_uart`
* ``zephyr,ot-uart`` used in OpenThread,
for example see :zephyr:code-sample:`coprocessor`
for example see :zephyr:code-sample:`openthread-coprocessor`
* ``zephyr,shell-uart`` used by shell for serial backend,
for example see :zephyr_file:`samples/subsys/shell/shell_module`
* ``zephyr,uart-mcumgr`` used by :zephyr:code-sample:`smp-svr` sample
Expand Down
5 changes: 5 additions & 0 deletions samples/net/openthread/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. zephyr:code-sample-category:: openthread
:name: OpenThread
:show-listing:

These samples demonstrate various use cases for the Thread protocol and underlying IEEE 802.15.4.
4 changes: 1 addition & 3 deletions samples/net/openthread/coprocessor/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. zephyr:code-sample:: coprocessor
.. zephyr:code-sample:: openthread-coprocessor
:name: OpenThread co-processor
:relevant-api: openthread

Expand Down

0 comments on commit 17cde7d

Please sign in to comment.