adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

samples: net: openthread: create category in docs

Browse source 
Add higher-level category for OpenThread in docs to avoid orphaned
sample documentation.

Signed-off-by: Martin Jäger <martin@libre.solar>
This commit is contained in:
Martin Jäger 2024-12-30 15:38:13 +01:00 committed by Benjamin Cabé
parent 8eff86229e
commit 17cde7d574
3 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/connectivity/usb/device/usb_device.rst
View file

@ -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

5
samples/net/openthread/README.rst Normal file
View file

@ -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
samples/net/openthread/coprocessor/README.rst
View file

@ -1,6 +1,4 @@
:orphan:
.. zephyr:code-sample:: coprocessor
.. zephyr:code-sample:: openthread-coprocessor
:name: OpenThread co-processor
:relevant-api: openthread