diff --git a/samples/modules/canopennode/README.rst b/samples/modules/canopennode/README.rst index 8a7a067c0d4..1af064efe13 100644 --- a/samples/modules/canopennode/README.rst +++ b/samples/modules/canopennode/README.rst @@ -1,7 +1,7 @@ -.. _canopennode-sample: +.. zephyr:code-sample:: canopennode + :name: CANopenNode -CANopenNode -########### + Use the CANopenNode CANopen protocol stack in Zephyr. Overview ******** diff --git a/samples/modules/chre/README.rst b/samples/modules/chre/README.rst index 22a43a58432..4dbf18b510e 100644 --- a/samples/modules/chre/README.rst +++ b/samples/modules/chre/README.rst @@ -1,5 +1,10 @@ -Android's Context Hub Runtime Environment (CHRE) -################################################ +.. zephyr:code-sample:: chre + :name: Android's Context Hub Runtime Environment (CHRE) + + Run nanoapps on Zephyr using the Context Hub Runtime Environment (CHRE). + +Overview +======== Android's context hub enables the use of nanoapps. A single nanoapp has 3 entry points seen in `chre_api/chre/nanoapp.h`_: diff --git a/samples/modules/cmsis_dsp/cmsis_dsp.rst b/samples/modules/cmsis_dsp/cmsis_dsp.rst new file mode 100644 index 00000000000..dce6b8cad96 --- /dev/null +++ b/samples/modules/cmsis_dsp/cmsis_dsp.rst @@ -0,0 +1,12 @@ +CMSIS-DSP +######### + +These samples demonstrate how to use the CMSIS-DSP module to perform signal processing operations +in Zephyr. + +.. toctree:: + :titlesonly: + :glob: + :maxdepth: 1 + + */* diff --git a/samples/modules/compression/lz4/README.rst b/samples/modules/compression/lz4/README.rst index 436e9a4e430..3cdeea47f72 100644 --- a/samples/modules/compression/lz4/README.rst +++ b/samples/modules/compression/lz4/README.rst @@ -1,7 +1,7 @@ -.. _lz4: +.. zephyr:code-sample:: lz4 + :name: LZ4 -LZ4 -### + Compress and decompress data using the LZ4 module. Overview ******** diff --git a/samples/modules/index.rst b/samples/modules/index.rst index 5316bb6e244..c40b9fe7850 100644 --- a/samples/modules/index.rst +++ b/samples/modules/index.rst @@ -5,7 +5,7 @@ External Module Samples .. toctree:: :titlesonly: - :maxdepth: 1 + :maxdepth: 2 :glob: - **/* + */* diff --git a/samples/modules/lvgl/lvgl.rst b/samples/modules/lvgl/lvgl.rst new file mode 100644 index 00000000000..736ddd1a00b --- /dev/null +++ b/samples/modules/lvgl/lvgl.rst @@ -0,0 +1,13 @@ +.. _lvgl_samples: + +LVGL +#### + +These samples demonstrate how to build graphical user interfaces using LVGL in Zephyr. + +.. toctree:: + :titlesonly: + :glob: + :maxdepth: 1 + + **/* diff --git a/samples/modules/nanopb/README.rst b/samples/modules/nanopb/README.rst index 86bb6e08c45..fb78ad677f4 100644 --- a/samples/modules/nanopb/README.rst +++ b/samples/modules/nanopb/README.rst @@ -1,7 +1,7 @@ -.. _nanopb_sample: +.. zephyr:code-sample:: nanopb + :name: Nanopb -Nanopb sample -############# + Serialize and deserialize structured data using the nanopb module. Overview ******** diff --git a/samples/modules/tflite-micro/hello_world/README.rst b/samples/modules/tflite-micro/hello_world/README.rst index 5a8492cc889..f88e12f1323 100644 --- a/samples/modules/tflite-micro/hello_world/README.rst +++ b/samples/modules/tflite-micro/hello_world/README.rst @@ -1,7 +1,7 @@ -.. _tensorflow_hello_world: +.. zephyr:code-sample:: tflite-hello-world + :name: Hello World -TensorFlow Lite Micro Hello World sample -######################################## + Replicate a sine wave using TensorFlow Lite for Microcontrollers. Overview ******** diff --git a/samples/modules/tflite-micro/magic_wand/README.rst b/samples/modules/tflite-micro/magic_wand/README.rst index 21839d7ec46..e1ca13faf58 100644 --- a/samples/modules/tflite-micro/magic_wand/README.rst +++ b/samples/modules/tflite-micro/magic_wand/README.rst @@ -1,7 +1,8 @@ -.. _tensorflow_magic_wand: +.. zephyr:code-sample:: tflite-magicwand + :name: Magic Wand -TensorFlow Lite Micro Magic Wand sample -####################################### + Recognize gestures from an accelerometer using TensorFlow Lite for Microcontrollers and a 20KB + neural network. Overview ******** diff --git a/samples/modules/tflite-micro/tflite-micro.rst b/samples/modules/tflite-micro/tflite-micro.rst new file mode 100644 index 00000000000..861618a645b --- /dev/null +++ b/samples/modules/tflite-micro/tflite-micro.rst @@ -0,0 +1,13 @@ +.. _tflitemicro_samples: + +TensorFlow Lite for Microcontrollers +#################################### + +These samples demonstrate how to use TensorFlow Lite for Microcontrollers in Zephyr. + +.. toctree:: + :titlesonly: + :glob: + :maxdepth: 1 + + **/* diff --git a/samples/modules/tflite-micro/tflm_ethosu/README.rst b/samples/modules/tflite-micro/tflm_ethosu/README.rst index a099f8140c7..46583daab3b 100644 --- a/samples/modules/tflite-micro/tflm_ethosu/README.rst +++ b/samples/modules/tflite-micro/tflm_ethosu/README.rst @@ -1,7 +1,10 @@ -.. _tflm_ethosu: +.. zephyr:code-sample:: tflite-ethosu + :name: TensorFlow Lite for Microcontrollers on Arm Ethos-U -Arm(R) Ethos(TM)-U Tensorflow Lite for Microcontrollers test application -######################################################################## + Run an inference using an optimized TFLite model on Arm Ethos-U NPU. + +Overview +******** A sample application that demonstrates how to run an inference using the TFLM framework and the Arm Ethos-U NPU. diff --git a/samples/modules/thrift/hello/README.rst b/samples/modules/thrift/hello/README.rst index 53b400a4c0b..8451d3df96a 100644 --- a/samples/modules/thrift/hello/README.rst +++ b/samples/modules/thrift/hello/README.rst @@ -1,7 +1,10 @@ -.. _thrift-hello-sample: +.. zephyr:code-sample:: thrift-hello + :name: Apache Thrift Hello World -Thrift sample -############# + Implement a simple Apache Thrift client-server application. + +Overview +******** .. figure:: thrift-layers.png :align: center diff --git a/samples/modules/thrift/thrift.rst b/samples/modules/thrift/thrift.rst new file mode 100644 index 00000000000..3ea28f1831b --- /dev/null +++ b/samples/modules/thrift/thrift.rst @@ -0,0 +1,11 @@ +Apache Thrift +============= + +These samples demonstrate how to use Apache Thrift in Zephyr. + +.. toctree:: + :titlesonly: + :glob: + :maxdepth: 1 + + */*