From 93e66f87764404307fc807d954246cd7e612e523 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Mon, 16 Sep 2024 10:55:34 +0200 Subject: [PATCH] [nrf fromtree] doc: samples: Adopt code-sample-category across tree MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit uses the new .. zephyr:code-sample-category directive to categorize code samples across the tree. Updates existing legacy references to manually defined targets to now use :zephyr:code-sample-category: role instead. Signed-off-by: Benjamin Cabé (cherry picked from commit 1db9b009a70e92cb75ef2e403f06a7a5bff022ef) Signed-off-by: Sean Madigan --- .../feather_m0_basic_proto/doc/index.rst | 2 +- boards/adafruit/feather_m0_lora/doc/index.rst | 2 +- .../grand_central_m4_express/doc/index.rst | 2 +- .../itsybitsy_m4_express/doc/index.rst | 2 +- boards/adafruit/trinket_m0/doc/index.rst | 2 +- boards/arduino/mkrzero/doc/index.rst | 2 +- boards/arduino/nano_33_iot/doc/index.rst | 2 +- boards/arduino/zero/doc/index.rst | 2 +- .../esp32_devkitc_wroom/doc/index.rst | 2 +- .../esp32_devkitc_wrover/doc/index.rst | 2 +- .../espressif/esp32s3_devkitc/doc/index.rst | 2 +- .../espressif/esp32s3_devkitm/doc/index.rst | 2 +- boards/openisa/rv32m1_vega/doc/index.rst | 2 +- boards/others/serpente/doc/index.rst | 2 +- boards/seeed/seeeduino_xiao/doc/index.rst | 2 +- boards/seeed/wio_terminal/doc/index.rst | 2 +- boards/shields/npm1300_ek/doc/index.rst | 2 +- boards/shields/npm6001_ek/doc/index.rst | 2 +- boards/snps/hsdk/doc/index.rst | 6 +-- boards/snps/hsdk4xd/doc/index.rst | 5 +-- .../esp32s3_touch_lcd_1_28/doc/index.rst | 2 +- doc/connectivity/bluetooth/bluetooth-arch.rst | 2 +- doc/connectivity/bluetooth/bluetooth-dev.rst | 2 +- doc/connectivity/usb/device/usb_device.rst | 2 +- doc/connectivity/usb/pd/ucds.rst | 2 +- doc/develop/application/index.rst | 4 +- doc/develop/beyond-GSG.rst | 2 +- doc/develop/getting_started/index.rst | 2 +- doc/releases/release-notes-1.7.rst | 2 +- doc/services/device_mgmt/ota.rst | 8 ++-- .../portability/posix/overview/index.rst | 3 +- .../application_development.rst | 13 ++---- samples/arch/index.rst | 13 ++---- samples/arch/mpu/index.rst | 14 +++---- samples/arch/smp/index.rst | 13 ++---- samples/basic/basic.rst | 13 ++---- .../bap_broadcast_assistant/README.rst | 2 +- .../bluetooth/bap_broadcast_sink/README.rst | 2 +- .../bluetooth/bap_broadcast_source/README.rst | 2 +- .../bluetooth/bap_unicast_client/README.rst | 2 +- .../bluetooth/bap_unicast_server/README.rst | 2 +- samples/bluetooth/beacon/README.rst | 2 +- samples/bluetooth/bluetooth.rst | 14 +++---- samples/bluetooth/broadcaster/README.rst | 2 +- .../bluetooth/broadcaster_multiple/README.rst | 2 +- .../bthome_sensor_template/README.rst | 2 +- samples/bluetooth/cap_acceptor/README.rst | 2 +- samples/bluetooth/cap_initiator/README.rst | 2 +- samples/bluetooth/central/README.rst | 2 +- .../bluetooth/central_gatt_write/README.rst | 2 +- samples/bluetooth/central_hr/README.rst | 2 +- samples/bluetooth/central_ht/README.rst | 2 +- .../bluetooth/central_multilink/README.rst | 2 +- samples/bluetooth/central_otc/README.rst | 2 +- samples/bluetooth/central_past/README.rst | 2 +- samples/bluetooth/direct_adv/README.rst | 2 +- samples/bluetooth/eddystone/README.rst | 2 +- .../encrypted_advertising/README.rst | 2 +- samples/bluetooth/extended_adv/README.rst | 2 +- samples/bluetooth/handsfree/README.rst | 2 +- samples/bluetooth/handsfree_ag/README.rst | 2 +- samples/bluetooth/hap_ha/README.rst | 2 +- samples/bluetooth/hci_ipc/README.rst | 2 +- samples/bluetooth/hci_pwr_ctrl/README.rst | 2 +- samples/bluetooth/hci_spi/README.rst | 2 +- samples/bluetooth/hci_usb/README.rst | 2 +- samples/bluetooth/hci_usb_h4/README.rst | 2 +- samples/bluetooth/hci_vs_scan_req/README.rst | 2 +- samples/bluetooth/ibeacon/README.rst | 2 +- samples/bluetooth/iso_broadcast/README.rst | 2 +- .../iso_broadcast_benchmark/README.rst | 2 +- samples/bluetooth/iso_central/README.rst | 2 +- .../iso_connected_benchmark/README.rst | 2 +- samples/bluetooth/iso_peripheral/README.rst | 2 +- samples/bluetooth/iso_receive/README.rst | 2 +- samples/bluetooth/mesh/README.rst | 2 +- samples/bluetooth/mesh_demo/README.rst | 2 +- samples/bluetooth/mesh_provisioner/README.rst | 2 +- samples/bluetooth/mtu_update/README.rst | 2 +- samples/bluetooth/observer/README.rst | 2 +- .../pbp_public_broadcast_sink/README.rst | 2 +- .../pbp_public_broadcast_source/README.rst | 2 +- samples/bluetooth/periodic_adv/README.rst | 2 +- .../bluetooth/periodic_adv_conn/README.rst | 2 +- samples/bluetooth/periodic_adv_rsp/README.rst | 2 +- samples/bluetooth/periodic_sync/README.rst | 2 +- .../bluetooth/periodic_sync_conn/README.rst | 2 +- .../bluetooth/periodic_sync_rsp/README.rst | 2 +- samples/bluetooth/peripheral/README.rst | 2 +- .../peripheral_accept_list/README.rst | 2 +- samples/bluetooth/peripheral_csc/README.rst | 2 +- samples/bluetooth/peripheral_dis/README.rst | 2 +- samples/bluetooth/peripheral_esp/README.rst | 2 +- .../peripheral_gatt_write/README.rst | 2 +- samples/bluetooth/peripheral_hids/README.rst | 2 +- samples/bluetooth/peripheral_hr/README.rst | 2 +- samples/bluetooth/peripheral_ht/README.rst | 2 +- .../bluetooth/peripheral_identity/README.rst | 2 +- samples/bluetooth/peripheral_nus/README.rst | 2 +- samples/bluetooth/peripheral_ots/README.rst | 2 +- samples/bluetooth/peripheral_past/README.rst | 2 +- .../bluetooth/peripheral_sc_only/README.rst | 2 +- samples/bluetooth/scan_adv/README.rst | 2 +- samples/bluetooth/st_ble_sensor/README.rst | 2 +- samples/bluetooth/tmap_bmr/README.rst | 2 +- samples/bluetooth/tmap_bms/README.rst | 2 +- samples/bluetooth/tmap_central/README.rst | 2 +- samples/bluetooth/tmap_peripheral/README.rst | 2 +- samples/boards/96boards/argonkey/index.rst | 13 ++---- samples/boards/96boards/index.rst | 13 ++---- samples/boards/arc_secure_services/README.rst | 2 + samples/boards/bbc/index.rst | 14 ++----- samples/boards/bbc/microbit/microbit.rst | 13 ++---- samples/boards/boards.rst | 14 ++----- samples/boards/enjoydigital/index.rst | 14 +++---- .../boards/enjoydigital/litex/i2s/README.rst | 2 + samples/boards/espressif/index.rst | 13 ++---- samples/boards/google/index.rst | 14 +++---- samples/boards/intel/index.rst | 14 +++---- samples/boards/microchip/index.rst | 13 ++---- .../mec15xxevb_assy6853.rst | 13 ++---- samples/boards/nordic/index.rst | 14 +++---- .../boards/nordic/mesh/onoff-app/README.rst | 2 +- .../onoff_level_lighting_vnd_app/README.rst | 2 +- samples/boards/nxp/index.rst | 14 +++---- samples/boards/phytec/index.rst | 13 ++---- samples/boards/phytec/reel_board/index.rst | 5 +++ .../phytec/reel_board/mesh_badge/README.rst | 2 +- samples/boards/quicklogic/index.rst | 13 ++---- samples/boards/st/bluetooth/index.rst | 5 +++ samples/boards/st/index.rst | 14 +++---- samples/boards/st/power_mgmt/index.rst | 5 +++ samples/boards/ti/index.rst | 14 +++---- samples/classic.rst | 15 ------- samples/cpp/cpp.rst | 13 ++---- samples/drivers/adc/index.rst | 5 +++ samples/drivers/audio/index.rst | 5 +++ samples/drivers/can/index.rst | 5 +++ samples/drivers/counter/index.rst | 5 +++ samples/drivers/drivers.rst | 17 +++----- samples/drivers/ethernet/index.rst | 5 +++ samples/drivers/fpga/index.rst | 5 +++ samples/drivers/haptics/README.rst | 5 +++ samples/drivers/i2c/README.rst | 5 +++ samples/drivers/i2s/README.rst | 5 +++ samples/drivers/ipm/README.rst | 5 +++ samples/drivers/led/index.rst | 5 +++ samples/drivers/lora/index.rst | 6 +++ samples/drivers/misc/README.rst | 5 +++ samples/drivers/mspi/index.rst | 5 +++ samples/drivers/uart/README.rst | 5 +++ samples/drivers/video/video.rst | 13 ++---- samples/drivers/virtualization/index.rst | 6 +++ samples/drivers/w1/README.rst | 5 +++ samples/fuel_gauge/fuel_gauge.rst | 13 ++---- samples/fuel_gauge/max17048/README.rst | 6 +-- samples/index.rst | 42 +++++++------------ .../condition_variables/simple/README.rst | 2 + samples/kernel/index.rst | 14 +++---- samples/modules/cmsis_dsp/cmsis_dsp.rst | 16 +++---- samples/modules/compression/compression.rst | 13 ++---- samples/modules/index.rst | 14 ++----- samples/modules/lvgl/lvgl.rst | 16 ++----- samples/modules/tflite-micro/tflite-micro.rst | 16 ++----- samples/modules/thrift/thrift.rst | 14 ++----- samples/net/cloud/README.rst | 5 +++ samples/net/net.rst | 14 +++---- samples/net/openthread/coprocessor/README.rst | 2 + samples/net/sockets/sockets.rst | 5 +++ samples/posix/posix.rst | 13 ++---- samples/sensor/sensor.rst | 13 ++---- samples/shields/npm1300_ek/doc/index.rst | 6 +-- samples/shields/npm6001_ek/doc/index.rst | 6 +-- samples/shields/shields.rst | 14 +++---- samples/shields/x_nucleo_iks01a2/README.rst | 5 +++ samples/shields/x_nucleo_iks01a3/README.rst | 5 +++ samples/shields/x_nucleo_iks02a1/README.rst | 5 +++ samples/shields/x_nucleo_iks4a1/README.rst | 5 +++ samples/subsys/bindesc/bindesc.rst | 13 ++---- samples/subsys/canbus/canbus.rst | 7 ++++ samples/subsys/console/console.rst | 13 ++---- samples/subsys/debug/index.rst | 13 ++---- samples/subsys/display/display.rst | 13 ++---- samples/subsys/fs/fs.rst | 13 ++---- samples/subsys/input/input.rst | 13 ++---- samples/subsys/ipc/ipc.rst | 14 +++---- samples/subsys/llext/llext.rst | 13 ++---- samples/subsys/logging/logging.rst | 13 ++---- samples/subsys/lorawan/lorawan.rst | 13 ++---- samples/subsys/mgmt/mcumgr/smp_svr/README.rst | 2 + samples/subsys/mgmt/mgmt.rst | 13 ++---- samples/subsys/modbus/modbus.rst | 13 ++---- samples/subsys/portability/portability.rst | 16 +++---- samples/subsys/profiling/profiling.rst | 13 ++---- samples/subsys/sensing/sensing.rst | 13 ++---- samples/subsys/shell/shell.rst | 13 ++---- samples/subsys/smf/smf.rst | 13 ++---- samples/subsys/subsys.rst | 14 ++----- samples/subsys/testsuite/testsuite.rst | 14 ++----- samples/subsys/usb/usb.rst | 14 +++---- samples/subsys/usb_c/usbc.rst | 13 ++---- samples/subsys/zbus/zbus.rst | 13 ++---- samples/sysbuild/sysbuild.rst | 13 ++---- samples/sysbuild/with_mcuboot/README.rst | 6 +-- samples/tfm_integration/tfm_integration.rst | 16 +++---- samples/userspace/hello_world_user/README.rst | 6 +-- samples/userspace/index.rst | 13 ++---- samples/userspace/prod_consumer/README.rst | 8 ++-- samples/userspace/shared_mem/README.rst | 6 +-- samples/userspace/syscall_perf/README.rst | 5 ++- 210 files changed, 573 insertions(+), 766 deletions(-) create mode 100644 samples/boards/phytec/reel_board/index.rst create mode 100644 samples/boards/st/bluetooth/index.rst create mode 100644 samples/boards/st/power_mgmt/index.rst delete mode 100644 samples/classic.rst create mode 100644 samples/drivers/adc/index.rst create mode 100644 samples/drivers/audio/index.rst create mode 100644 samples/drivers/can/index.rst create mode 100644 samples/drivers/counter/index.rst create mode 100644 samples/drivers/ethernet/index.rst create mode 100644 samples/drivers/fpga/index.rst create mode 100644 samples/drivers/haptics/README.rst create mode 100644 samples/drivers/i2c/README.rst create mode 100644 samples/drivers/i2s/README.rst create mode 100644 samples/drivers/ipm/README.rst create mode 100644 samples/drivers/led/index.rst create mode 100644 samples/drivers/lora/index.rst create mode 100644 samples/drivers/misc/README.rst create mode 100644 samples/drivers/mspi/index.rst create mode 100644 samples/drivers/uart/README.rst create mode 100644 samples/drivers/virtualization/index.rst create mode 100644 samples/drivers/w1/README.rst create mode 100644 samples/net/cloud/README.rst create mode 100644 samples/net/sockets/sockets.rst create mode 100644 samples/shields/x_nucleo_iks01a2/README.rst create mode 100644 samples/shields/x_nucleo_iks01a3/README.rst create mode 100644 samples/shields/x_nucleo_iks02a1/README.rst create mode 100644 samples/shields/x_nucleo_iks4a1/README.rst diff --git a/boards/adafruit/feather_m0_basic_proto/doc/index.rst b/boards/adafruit/feather_m0_basic_proto/doc/index.rst index 04206783b15..a01fe241d59 100644 --- a/boards/adafruit/feather_m0_basic_proto/doc/index.rst +++ b/boards/adafruit/feather_m0_basic_proto/doc/index.rst @@ -96,7 +96,7 @@ USB Device Port =============== The SAMD21 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/adafruit/feather_m0_lora/doc/index.rst b/boards/adafruit/feather_m0_lora/doc/index.rst index b75f73d6fdc..92d63b36ce3 100644 --- a/boards/adafruit/feather_m0_lora/doc/index.rst +++ b/boards/adafruit/feather_m0_lora/doc/index.rst @@ -99,7 +99,7 @@ USB Device Port =============== The SAMD21 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/adafruit/grand_central_m4_express/doc/index.rst b/boards/adafruit/grand_central_m4_express/doc/index.rst index e9cf733843a..0244fa73f87 100644 --- a/boards/adafruit/grand_central_m4_express/doc/index.rst +++ b/boards/adafruit/grand_central_m4_express/doc/index.rst @@ -98,7 +98,7 @@ USB Device Port =============== The SAMD51 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/adafruit/itsybitsy_m4_express/doc/index.rst b/boards/adafruit/itsybitsy_m4_express/doc/index.rst index ce3efb89b1f..2ab1f7a5853 100644 --- a/boards/adafruit/itsybitsy_m4_express/doc/index.rst +++ b/boards/adafruit/itsybitsy_m4_express/doc/index.rst @@ -106,7 +106,7 @@ USB Device Port =============== The SAMD51 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/adafruit/trinket_m0/doc/index.rst b/boards/adafruit/trinket_m0/doc/index.rst index e02b829d7a0..4714f9d1aff 100644 --- a/boards/adafruit/trinket_m0/doc/index.rst +++ b/boards/adafruit/trinket_m0/doc/index.rst @@ -98,7 +98,7 @@ USB Device Port =============== The SAMD21 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/arduino/mkrzero/doc/index.rst b/boards/arduino/mkrzero/doc/index.rst index 2ea120d9313..b6f92d96930 100644 --- a/boards/arduino/mkrzero/doc/index.rst +++ b/boards/arduino/mkrzero/doc/index.rst @@ -111,7 +111,7 @@ USB Device Port =============== The SAMD21 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/arduino/nano_33_iot/doc/index.rst b/boards/arduino/nano_33_iot/doc/index.rst index e6a51198b92..419c02a5cea 100644 --- a/boards/arduino/nano_33_iot/doc/index.rst +++ b/boards/arduino/nano_33_iot/doc/index.rst @@ -102,7 +102,7 @@ USB Device Port =============== The SAMD21 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/arduino/zero/doc/index.rst b/boards/arduino/zero/doc/index.rst index 3ec0a0fd82a..9e665aa75cd 100644 --- a/boards/arduino/zero/doc/index.rst +++ b/boards/arduino/zero/doc/index.rst @@ -98,7 +98,7 @@ USB Device Port =============== The SAMD21 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/espressif/esp32_devkitc_wroom/doc/index.rst b/boards/espressif/esp32_devkitc_wroom/doc/index.rst index 68955f9c17c..4107dbf6cfe 100644 --- a/boards/espressif/esp32_devkitc_wroom/doc/index.rst +++ b/boards/espressif/esp32_devkitc_wroom/doc/index.rst @@ -54,7 +54,7 @@ Asymmetric Multiprocessing (AMP) ******************************** ESP32-DevKitC-WROOM allows 2 different applications to be executed in ESP32 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode -and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference. +and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference. Supported Features ================== diff --git a/boards/espressif/esp32_devkitc_wrover/doc/index.rst b/boards/espressif/esp32_devkitc_wrover/doc/index.rst index 81c75c598ca..79bb94f6b1a 100644 --- a/boards/espressif/esp32_devkitc_wrover/doc/index.rst +++ b/boards/espressif/esp32_devkitc_wrover/doc/index.rst @@ -54,7 +54,7 @@ Asymmetric Multiprocessing (AMP) ******************************** ESP32-DevKitC-WROVER allows 2 different applications to be executed in ESP32 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode -and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference. +and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference. Supported Features ================== diff --git a/boards/espressif/esp32s3_devkitc/doc/index.rst b/boards/espressif/esp32s3_devkitc/doc/index.rst index 984a714d0f7..cd49316dacd 100644 --- a/boards/espressif/esp32s3_devkitc/doc/index.rst +++ b/boards/espressif/esp32s3_devkitc/doc/index.rst @@ -76,7 +76,7 @@ Asymmetric Multiprocessing (AMP) ESP32S3-DevKitC allows 2 different applications to be executed in ESP32-S3 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode -and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference. +and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference. For more information, check the datasheet at `ESP32-S3 Datasheet`_ or the technical reference manual at `ESP32-S3 Technical Reference Manual`_. diff --git a/boards/espressif/esp32s3_devkitm/doc/index.rst b/boards/espressif/esp32s3_devkitm/doc/index.rst index b1e79766ed9..04a3997abba 100644 --- a/boards/espressif/esp32s3_devkitm/doc/index.rst +++ b/boards/espressif/esp32s3_devkitm/doc/index.rst @@ -76,7 +76,7 @@ Asymmetric Multiprocessing (AMP) ESP32S3-DevKitM allows 2 different applications to be executed in ESP32-S3 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode -and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference. +and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference. For more information, check the datasheet at `ESP32-S3 Datasheet`_ or the technical reference manual at `ESP32-S3 Technical Reference Manual`_. diff --git a/boards/openisa/rv32m1_vega/doc/index.rst b/boards/openisa/rv32m1_vega/doc/index.rst index 92d9e999752..a8ff0b6c4b8 100644 --- a/boards/openisa/rv32m1_vega/doc/index.rst +++ b/boards/openisa/rv32m1_vega/doc/index.rst @@ -578,7 +578,7 @@ toolchain and OpenOCD:: You need to make sure this happens every time you use this board. Now let's compile the :zephyr:code-sample:`hello_world` application. (You can try -others as well; see :ref:`samples-and-demos` for more.) +others as well; see :zephyr:code-sample-category:`samples` for more.) .. We can't use zephyr-app-commands to provide build instructions due to the below mentioned linker issue. diff --git a/boards/others/serpente/doc/index.rst b/boards/others/serpente/doc/index.rst index c624c5ad062..e7140707d74 100644 --- a/boards/others/serpente/doc/index.rst +++ b/boards/others/serpente/doc/index.rst @@ -74,7 +74,7 @@ USB Device Port =============== The SAMD21 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which prints "Hello World!" to the host PC. diff --git a/boards/seeed/seeeduino_xiao/doc/index.rst b/boards/seeed/seeeduino_xiao/doc/index.rst index 8f3614918f6..48003fdb63c 100644 --- a/boards/seeed/seeeduino_xiao/doc/index.rst +++ b/boards/seeed/seeeduino_xiao/doc/index.rst @@ -98,7 +98,7 @@ USB Device Port =============== The SAMD21 MCU has a USB device port that can be used to communicate -with a host PC. See the :ref:`usb-samples` sample applications for +with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/seeed/wio_terminal/doc/index.rst b/boards/seeed/wio_terminal/doc/index.rst index 73cef0f3c5b..f640f11b445 100644 --- a/boards/seeed/wio_terminal/doc/index.rst +++ b/boards/seeed/wio_terminal/doc/index.rst @@ -121,7 +121,7 @@ USB Device Port =============== The SAMD51 MCU has a USB device port that can be used to communicate with a -host PC. See the :ref:`usb-samples` sample applications for more, such as the +host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos characters back to the host PC. diff --git a/boards/shields/npm1300_ek/doc/index.rst b/boards/shields/npm1300_ek/doc/index.rst index f46a8cf47a0..816c31a5fff 100644 --- a/boards/shields/npm1300_ek/doc/index.rst +++ b/boards/shields/npm1300_ek/doc/index.rst @@ -22,7 +22,7 @@ Usage ***** The shield can be used in any application by setting ``--shield npm1300_ek`` -when invoking ``west build``. You can check :ref:`npm1300_ek_sample` for a +when invoking ``west build``. You can check :zephyr:code-sample:`npm1300_ek` for a comprehensive sample. References diff --git a/boards/shields/npm6001_ek/doc/index.rst b/boards/shields/npm6001_ek/doc/index.rst index bc982d7f436..32305cd5a8c 100644 --- a/boards/shields/npm6001_ek/doc/index.rst +++ b/boards/shields/npm6001_ek/doc/index.rst @@ -28,7 +28,7 @@ Usage ***** The shield can be used in any application by setting ``--shield npm6001_ek`` -when invoking ``west build``. You can check :ref:`npm6001_ek_sample` for a +when invoking ``west build``. You can check :zephyr:code-sample:`npm6001_ek` for a comprehensive sample. References diff --git a/boards/snps/hsdk/doc/index.rst b/boards/snps/hsdk/doc/index.rst index a7165a27658..b79ecbca968 100644 --- a/boards/snps/hsdk/doc/index.rst +++ b/boards/snps/hsdk/doc/index.rst @@ -387,9 +387,9 @@ Set up Zephyr Software Building Sample Applications ============================== -You can try many of the :ref:`sample applications and demos -`. We'll use :zephyr:code-sample:`hello_world`, found in -:zephyr_file:`samples/hello_world` as an example. +You can try many of the :zephyr:code-sample-category:`sample applications and demos `. +We'll use :zephyr:code-sample:`hello_world`, found in :zephyr_file:`samples/hello_world` as an +example. Configuring ----------- diff --git a/boards/snps/hsdk4xd/doc/index.rst b/boards/snps/hsdk4xd/doc/index.rst index a5cfd534c00..04b30bcaf9b 100644 --- a/boards/snps/hsdk4xd/doc/index.rst +++ b/boards/snps/hsdk4xd/doc/index.rst @@ -384,9 +384,8 @@ Set up Zephyr Software Building Sample Applications ============================== -You can try many of the :ref:`sample applications and demos -`. We'll use :zephyr:code-sample:`hello_world`, found in -:zephyr_file:`samples/hello_world` as an example. +You can try many of the :zephyr:code-sample-category:`sample applications and demos `. +We'll use :zephyr:code-sample:`hello_world`, found in :zephyr_file:`samples/hello_world` as an example. Configuring ----------- diff --git a/boards/waveshare/esp32s3_touch_lcd_1_28/doc/index.rst b/boards/waveshare/esp32s3_touch_lcd_1_28/doc/index.rst index 2d56d559b96..b80884a2e96 100644 --- a/boards/waveshare/esp32s3_touch_lcd_1_28/doc/index.rst +++ b/boards/waveshare/esp32s3_touch_lcd_1_28/doc/index.rst @@ -52,7 +52,7 @@ Asymmetric Multiprocessing (AMP) ESP32-S3 allows 2 different applications to be executed in ESP32-S3 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode -and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference. +and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference. For more information, check the datasheet at `ESP32-S3 Datasheet`_ or the technical reference manual at `ESP32-S3 Technical Reference Manual`_. diff --git a/doc/connectivity/bluetooth/bluetooth-arch.rst b/doc/connectivity/bluetooth/bluetooth-arch.rst index c442412d2f4..04fcf365888 100644 --- a/doc/connectivity/bluetooth/bluetooth-arch.rst +++ b/doc/connectivity/bluetooth/bluetooth-arch.rst @@ -197,7 +197,7 @@ The stack is split up as follows in the source tree: have their own drivers. ``samples/bluetooth/`` - :ref:`Sample Bluetooth code `. This is a good reference to + :zephyr:code-sample-category:`Sample Bluetooth code `. This is a good reference to get started with Bluetooth application development. ``tests/bluetooth/`` diff --git a/doc/connectivity/bluetooth/bluetooth-dev.rst b/doc/connectivity/bluetooth/bluetooth-dev.rst index 05a7a672922..afefaf45a7e 100644 --- a/doc/connectivity/bluetooth/bluetooth-dev.rst +++ b/doc/connectivity/bluetooth/bluetooth-dev.rst @@ -189,7 +189,7 @@ and scan response data. More Examples ************* -More :ref:`sample Bluetooth applications ` are available in +More :zephyr:code-sample-category:`sample Bluetooth applications ` are available in ``samples/bluetooth/``. .. _BabbleSim: https://babblesim.github.io/ diff --git a/doc/connectivity/usb/device/usb_device.rst b/doc/connectivity/usb/device/usb_device.rst index fac90690727..30ee886ea8c 100644 --- a/doc/connectivity/usb/device/usb_device.rst +++ b/doc/connectivity/usb/device/usb_device.rst @@ -565,7 +565,7 @@ The USB Vendor ID for the Zephyr project is ``0x2FE3``. This USB Vendor ID must not be used when a vendor integrates Zephyr USB device support into its own product. -Each USB :ref:`sample` has its own unique Product ID. +Each USB :zephyr:code-sample-category:`sample` has its own unique Product ID. The USB maintainer, if one is assigned, or otherwise the Zephyr Technical Steering Committee, may allocate other USB Product IDs based on well-motivated and documented requests. diff --git a/doc/connectivity/usb/pd/ucds.rst b/doc/connectivity/usb/pd/ucds.rst index 609e3dfed2d..39b6a6030d9 100644 --- a/doc/connectivity/usb/pd/ucds.rst +++ b/doc/connectivity/usb/pd/ucds.rst @@ -17,7 +17,7 @@ It provides the following functionalities: Currently the device stack supports implementation of Sink only and Source only devices. Dual Role Power (DRP) devices are not yet supported. -:ref:`List` of samples for different purposes. +:zephyr:code-sample-category:`List` of samples for different purposes. Implementing a Sink Type-C and Power Delivery USB-C device ********************************************************** diff --git a/doc/develop/application/index.rst b/doc/develop/application/index.rst index bcad2900b88..6bf3620adfd 100644 --- a/doc/develop/application/index.rst +++ b/doc/develop/application/index.rst @@ -303,7 +303,7 @@ Creating an Application by Hand You can follow these steps to create a basic application directory from scratch. However, using the `example-application`_ repository or one of -Zephyr's :ref:`samples-and-demos` as a starting point is likely to be easier. +Zephyr's :zephyr:code-sample-category:`samples` as a starting point is likely to be easier. #. Create an application directory. @@ -643,7 +643,7 @@ assignment: CONFIG_CPP=y -Looking at :ref:`existing samples ` is a good way to get +Looking at :zephyr:code-sample-category:`existing samples ` is a good way to get started. See :ref:`setting_configuration_values` for detailed documentation on setting diff --git a/doc/develop/beyond-GSG.rst b/doc/develop/beyond-GSG.rst index 42f1f6c5f38..ab0a1aba84f 100644 --- a/doc/develop/beyond-GSG.rst +++ b/doc/develop/beyond-GSG.rst @@ -213,7 +213,7 @@ format. Other binary formats, disassembly, and map files may be present depending on your board. The other sample applications in the :zephyr_file:`samples` folder are -documented in :ref:`samples-and-demos`. +documented in :zephyr:code-sample-category:`samples`. .. note:: If you want to reuse an existing build directory for another board or application, you need to diff --git a/doc/develop/getting_started/index.rst b/doc/develop/getting_started/index.rst index 34f21e427cd..3cb87da9ec6 100644 --- a/doc/develop/getting_started/index.rst +++ b/doc/develop/getting_started/index.rst @@ -478,7 +478,7 @@ Next Steps Here are some next steps for exploring Zephyr: -* Try other :ref:`samples-and-demos` +* Try other :zephyr:code-sample-category:`samples` * Learn about :ref:`application` and the :ref:`west ` tool * Find out about west's :ref:`flashing and debugging ` features, or more about :ref:`flashing_and_debugging` in general diff --git a/doc/releases/release-notes-1.7.rst b/doc/releases/release-notes-1.7.rst index 8f4bce1a77e..e13dfdfd582 100644 --- a/doc/releases/release-notes-1.7.rst +++ b/doc/releases/release-notes-1.7.rst @@ -147,7 +147,7 @@ Documentation * Site-wide glossary added. * Porting guides added. * Sample README files converted to documents included in the website. -* Improved consistency of :ref:`boards` and :ref:`samples-and-demos`. +* Improved consistency of :ref:`boards` and :zephyr:code-sample-category:`samples`. JIRA Related Items diff --git a/doc/services/device_mgmt/ota.rst b/doc/services/device_mgmt/ota.rst index a61e1c7f545..4548ce8b028 100644 --- a/doc/services/device_mgmt/ota.rst +++ b/doc/services/device_mgmt/ota.rst @@ -45,7 +45,7 @@ is downloaded and installed. MCUboot can be used to verify the signature before upgrading the firmware. There is a :zephyr:code-sample:`hawkbit-api` sample included in the -Zephyr :ref:`mgmt-samples` section. +Zephyr :zephyr:code-sample-category:`mgmt` section. UpdateHub ========= @@ -56,7 +56,7 @@ the binary is downloaded and installed. MCUboot can be used to verify the signature before upgrading the firmware. There is an :zephyr:code-sample:`updatehub-fota` sample included in the Zephyr -:ref:`mgmt-samples` section. +:zephyr:code-sample-category:`mgmt` section. SMP Server ========== @@ -66,8 +66,8 @@ Bluetooth Low Energy (BLE) or UDP. :ref:`mcu_mgr` is used to send a signed firmware binary to the remote device where it is verified by MCUboot before the upgrade occurs. -There is an :zephyr:code-sample:`smp-svr` sample included in the Zephyr :ref:`mgmt-samples` -section. +There is an :zephyr:code-sample:`smp-svr` sample included in the Zephyr +:zephyr:code-sample-category:`mgmt` section. Lightweight M2M (LWM2M) ======================= diff --git a/doc/services/portability/posix/overview/index.rst b/doc/services/portability/posix/overview/index.rst index 6c352cf2454..c0ab06b6e8a 100644 --- a/doc/services/portability/posix/overview/index.rst +++ b/doc/services/portability/posix/overview/index.rst @@ -113,7 +113,8 @@ leverages the ``nanosleep()`` and ``perror()`` POSIX functions. return 0; } -For more examples of POSIX applications, please see the :ref:`POSIX sample applications`. +For more examples of POSIX applications, please see the +:zephyr:code-sample-category:`POSIX sample applications`. .. _posix_config: diff --git a/samples/application_development/application_development.rst b/samples/application_development/application_development.rst index f467600d235..9a7d9b2975a 100644 --- a/samples/application_development/application_development.rst +++ b/samples/application_development/application_development.rst @@ -1,16 +1,11 @@ -.. _application-development-samples: +.. zephyr:code-sample-category:: application_development + :name: Application Development + :show-listing: -Application development samples -############################### + These samples illustrate some useful application development patterns and techniques. For application development you should also consider looking at `example-application`_. Among others, you will find on it out of tree driver or board examples. -.. toctree:: - :maxdepth: 1 - :glob: - - **/* - .. _example-application: https://github.com/zephyrproject-rtos/example-application diff --git a/samples/arch/index.rst b/samples/arch/index.rst index a43bda20d80..fbc2871be9c 100644 --- a/samples/arch/index.rst +++ b/samples/arch/index.rst @@ -1,10 +1,5 @@ -.. _arch-samples: +.. zephyr:code-sample-category:: arch + :name: Architecture-dependent Samples + :show-listing: -Architecture Dependent Samples -############################## - -.. toctree:: - :maxdepth: 2 - :glob: - - */* + Samples that demonstrate some architecture-specific features. diff --git a/samples/arch/mpu/index.rst b/samples/arch/mpu/index.rst index 64016b946ad..b1161af69b6 100644 --- a/samples/arch/mpu/index.rst +++ b/samples/arch/mpu/index.rst @@ -1,10 +1,6 @@ -.. _mmu_mpu-samples: +.. zephyr:code-sample-category:: mmu_mpu + :name: MMU/MPU + :show-listing: -MMU/MPU Samples -############### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the Memory Management Unit (MMU) and Memory Protection Unit (MPU) + features. diff --git a/samples/arch/smp/index.rst b/samples/arch/smp/index.rst index 64c4660aaed..fe1ed4490a2 100644 --- a/samples/arch/smp/index.rst +++ b/samples/arch/smp/index.rst @@ -1,10 +1,5 @@ -.. _smp-samples: +.. zephyr:code-sample-category:: smp + :name: Symmetric Multiprocessing (SMP) + :show-listing: -Various SMP Samples -################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the use of :ref:`Symmetric Multiprocessing `. diff --git a/samples/basic/basic.rst b/samples/basic/basic.rst index d40b04527ac..7985892834c 100644 --- a/samples/basic/basic.rst +++ b/samples/basic/basic.rst @@ -1,10 +1,5 @@ -.. _basic-sample: +.. zephyr:code-sample-category:: basic + :name: Basic + :show-listing: -Basic Samples -############# - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate basic functionality of the Zephyr kernel. diff --git a/samples/bluetooth/bap_broadcast_assistant/README.rst b/samples/bluetooth/bap_broadcast_assistant/README.rst index 011631d6120..f8ba3fb582b 100644 --- a/samples/bluetooth/bap_broadcast_assistant/README.rst +++ b/samples/bluetooth/bap_broadcast_assistant/README.rst @@ -21,7 +21,7 @@ Source sample). This sample can be found under :zephyr_file:`samples/bluetooth/bap_broadcast_assistant` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Requirements ************ diff --git a/samples/bluetooth/bap_broadcast_sink/README.rst b/samples/bluetooth/bap_broadcast_sink/README.rst index efbb69e3810..52bb8208ef2 100644 --- a/samples/bluetooth/bap_broadcast_sink/README.rst +++ b/samples/bluetooth/bap_broadcast_sink/README.rst @@ -14,7 +14,7 @@ the first found and listens to it until the source is (potentially) stopped. This sample can be found under :zephyr_file:`samples/bluetooth/bap_broadcast_sink` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Use :kconfig:option:`CONFIG_TARGET_BROADCAST_NAME` Kconfig to specify the name (:kconfig:option:`CONFIG_BT_DEVICE_NAME`) of a broadcast source to listen to. With default value diff --git a/samples/bluetooth/bap_broadcast_source/README.rst b/samples/bluetooth/bap_broadcast_source/README.rst index 1baf971623b..f0dadc990c1 100644 --- a/samples/bluetooth/bap_broadcast_source/README.rst +++ b/samples/bluetooth/bap_broadcast_source/README.rst @@ -17,7 +17,7 @@ The broadcast source will reset every 30 seconds to show the full API. This sample can be found under :zephyr_file:`samples/bluetooth/bap_broadcast_source` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Requirements ************ diff --git a/samples/bluetooth/bap_unicast_client/README.rst b/samples/bluetooth/bap_unicast_client/README.rst index b99826f5fa0..b70667582d3 100644 --- a/samples/bluetooth/bap_unicast_client/README.rst +++ b/samples/bluetooth/bap_unicast_client/README.rst @@ -13,7 +13,7 @@ connects to a LE Audio unicast server and establishes an audio stream. This sample can be found under :zephyr_file:`samples/bluetooth/bap_unicast_client` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Requirements ************ diff --git a/samples/bluetooth/bap_unicast_server/README.rst b/samples/bluetooth/bap_unicast_server/README.rst index b24c6385443..f0b2de5e971 100644 --- a/samples/bluetooth/bap_unicast_server/README.rst +++ b/samples/bluetooth/bap_unicast_server/README.rst @@ -13,7 +13,7 @@ Starts advertising and awaits connection from a LE Audio unicast client. This sample can be found under :zephyr_file:`samples/bluetooth/bap_unicast_server` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Requirements ************ diff --git a/samples/bluetooth/beacon/README.rst b/samples/bluetooth/beacon/README.rst index 06e8d7e765a..20270aa23c7 100644 --- a/samples/bluetooth/beacon/README.rst +++ b/samples/bluetooth/beacon/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/beacon` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/bluetooth.rst b/samples/bluetooth/bluetooth.rst index 1c3d4d18d81..0c3b7a21f2f 100644 --- a/samples/bluetooth/bluetooth.rst +++ b/samples/bluetooth/bluetooth.rst @@ -1,7 +1,7 @@ -.. _bluetooth-samples: +.. zephyr:code-sample-category:: bluetooth + :name: Bluetooth -Bluetooth samples -################# + These samples demonstrate the use of Bluetooth in Zephyr. To build any of the Bluetooth samples, follow the same steps as building any other Zephyr application. Refer to :ref:`bluetooth-dev` for more information. @@ -29,8 +29,6 @@ documentation and are prefixed with :literal:`hci_` in their folder names. connections will fail. You can force a re-paring and new key to be created by removing the device from the associated devices list on the host. -.. toctree:: - :maxdepth: 1 - :glob: - - **/* +.. zephyr:code-sample-listing:: + :categories: bluetooth + :live-search: diff --git a/samples/bluetooth/broadcaster/README.rst b/samples/bluetooth/broadcaster/README.rst index 72e395d347a..60b47956e21 100644 --- a/samples/bluetooth/broadcaster/README.rst +++ b/samples/bluetooth/broadcaster/README.rst @@ -25,4 +25,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/broadcaster` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/broadcaster_multiple/README.rst b/samples/bluetooth/broadcaster_multiple/README.rst index 5170cf9dbff..c99595b12fc 100644 --- a/samples/bluetooth/broadcaster_multiple/README.rst +++ b/samples/bluetooth/broadcaster_multiple/README.rst @@ -34,4 +34,4 @@ To test this sample use the Observer sample with Extended Scanning enabled, found under :zephyr_file:`samples/bluetooth/observer` in the Zephyr tree. -See :ref:`Bluetooth samples section ` for details. +See :zephyr:code-sample-category:`Bluetooth samples section ` for details. diff --git a/samples/bluetooth/bthome_sensor_template/README.rst b/samples/bluetooth/bthome_sensor_template/README.rst index 94f438bd0fa..809dc282e90 100644 --- a/samples/bluetooth/bthome_sensor_template/README.rst +++ b/samples/bluetooth/bthome_sensor_template/README.rst @@ -20,7 +20,7 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/bthome_sensor_template` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. When the sample is running, navigate to Devices & Services under settings in Home Assistant. There you will be asked to configure the BTHome sensor if everything diff --git a/samples/bluetooth/cap_acceptor/README.rst b/samples/bluetooth/cap_acceptor/README.rst index 0a9854616f1..60c70e69bb2 100644 --- a/samples/bluetooth/cap_acceptor/README.rst +++ b/samples/bluetooth/cap_acceptor/README.rst @@ -12,7 +12,7 @@ Starts by advertising for a CAP Initiator to connect and set up available stream This sample can be found under :zephyr_file:`samples/bluetooth/cap_acceptor` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Requirements ************ diff --git a/samples/bluetooth/cap_initiator/README.rst b/samples/bluetooth/cap_initiator/README.rst index b3c84ff9dec..36c1631f1bf 100644 --- a/samples/bluetooth/cap_initiator/README.rst +++ b/samples/bluetooth/cap_initiator/README.rst @@ -13,7 +13,7 @@ audio streams, sets up a broadcast audio stream, or both. This sample can be found under :zephyr_file:`samples/bluetooth/cap_initiator` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Requirements ************ diff --git a/samples/bluetooth/central/README.rst b/samples/bluetooth/central/README.rst index ceb9710bdd4..0a47dd07b5c 100644 --- a/samples/bluetooth/central/README.rst +++ b/samples/bluetooth/central/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/central` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/central_gatt_write/README.rst b/samples/bluetooth/central_gatt_write/README.rst index 37ac2da26d8..0190374b994 100644 --- a/samples/bluetooth/central_gatt_write/README.rst +++ b/samples/bluetooth/central_gatt_write/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/central_gatt_write` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/central_hr/README.rst b/samples/bluetooth/central_hr/README.rst index af3d1be3e12..8d3e1b88a3c 100644 --- a/samples/bluetooth/central_hr/README.rst +++ b/samples/bluetooth/central_hr/README.rst @@ -23,4 +23,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/central_hr` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/central_ht/README.rst b/samples/bluetooth/central_ht/README.rst index 8c81e5aa80c..e0a58a7ea25 100644 --- a/samples/bluetooth/central_ht/README.rst +++ b/samples/bluetooth/central_ht/README.rst @@ -23,4 +23,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/central_ht` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/central_multilink/README.rst b/samples/bluetooth/central_multilink/README.rst index dcabb8785fc..61d64d79806 100644 --- a/samples/bluetooth/central_multilink/README.rst +++ b/samples/bluetooth/central_multilink/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/central_multilink` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/central_otc/README.rst b/samples/bluetooth/central_otc/README.rst index 18b4443c949..67b75f21aa6 100644 --- a/samples/bluetooth/central_otc/README.rst +++ b/samples/bluetooth/central_otc/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/central_otc` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/central_past/README.rst b/samples/bluetooth/central_past/README.rst index a39b1a3370c..a6b15fbf5c6 100644 --- a/samples/bluetooth/central_past/README.rst +++ b/samples/bluetooth/central_past/README.rst @@ -29,4 +29,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/peripheral_past` in the Zephyr tree on another board that will advertise and await a periodic advertising sync transfer. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/direct_adv/README.rst b/samples/bluetooth/direct_adv/README.rst index adc3a14ccab..65191c1636a 100644 --- a/samples/bluetooth/direct_adv/README.rst +++ b/samples/bluetooth/direct_adv/README.rst @@ -30,4 +30,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/direct_adv` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/eddystone/README.rst b/samples/bluetooth/eddystone/README.rst index d39c4cfdebb..1e1a555a689 100644 --- a/samples/bluetooth/eddystone/README.rst +++ b/samples/bluetooth/eddystone/README.rst @@ -26,6 +26,6 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/eddystone` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. .. _Eddystone Configuration Service: https://github.com/google/eddystone/tree/master/configuration-service diff --git a/samples/bluetooth/encrypted_advertising/README.rst b/samples/bluetooth/encrypted_advertising/README.rst index b62a479fcca..d55017f35ce 100644 --- a/samples/bluetooth/encrypted_advertising/README.rst +++ b/samples/bluetooth/encrypted_advertising/README.rst @@ -35,7 +35,7 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/encrypted_advertising` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. This sample uses two applications, so two devices need to be setup. Flash one device with the central application, and another device with the diff --git a/samples/bluetooth/extended_adv/README.rst b/samples/bluetooth/extended_adv/README.rst index b7901fd8e6b..f05fe6e2f64 100644 --- a/samples/bluetooth/extended_adv/README.rst +++ b/samples/bluetooth/extended_adv/README.rst @@ -34,7 +34,7 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/extended_adv` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. This sample uses two applications, so two devices need to be setup. Flash one device with the scanner application, and another device with the diff --git a/samples/bluetooth/handsfree/README.rst b/samples/bluetooth/handsfree/README.rst index 609139ef04a..2df63ba2ee1 100644 --- a/samples/bluetooth/handsfree/README.rst +++ b/samples/bluetooth/handsfree/README.rst @@ -21,4 +21,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/handsfree` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/handsfree_ag/README.rst b/samples/bluetooth/handsfree_ag/README.rst index 21c190ab360..e28d80433b0 100644 --- a/samples/bluetooth/handsfree_ag/README.rst +++ b/samples/bluetooth/handsfree_ag/README.rst @@ -21,4 +21,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/handsfree_ag` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/hap_ha/README.rst b/samples/bluetooth/hap_ha/README.rst index 945ceaa5ef5..9960c02d3de 100644 --- a/samples/bluetooth/hap_ha/README.rst +++ b/samples/bluetooth/hap_ha/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/hap_ha` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/hci_ipc/README.rst b/samples/bluetooth/hci_ipc/README.rst index be2634ba5c1..8f01d3f0619 100644 --- a/samples/bluetooth/hci_ipc/README.rst +++ b/samples/bluetooth/hci_ipc/README.rst @@ -37,4 +37,4 @@ You might need to adjust the Kconfig configuration of this sample to make it compatible with the peer application. For example, :kconfig:option:`CONFIG_BT_MAX_CONN` must be equal to the maximum number of connections supported by the peer application. -Refer to :ref:`bluetooth-samples` for general information about Bluetooth samples. +Refer to :zephyr:code-sample-category:`bluetooth` for general information about Bluetooth samples. diff --git a/samples/bluetooth/hci_pwr_ctrl/README.rst b/samples/bluetooth/hci_pwr_ctrl/README.rst index b902b07534e..00d89d06738 100644 --- a/samples/bluetooth/hci_pwr_ctrl/README.rst +++ b/samples/bluetooth/hci_pwr_ctrl/README.rst @@ -35,4 +35,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/hci_pwr_ctrl` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/hci_spi/README.rst b/samples/bluetooth/hci_spi/README.rst index 70c6e465a86..1276889e6a5 100644 --- a/samples/bluetooth/hci_spi/README.rst +++ b/samples/bluetooth/hci_spi/README.rst @@ -36,6 +36,6 @@ application is compatible with the HCI SPI master driver provided by Zephyr's Bluetooth HCI driver core; see the help associated with the :kconfig:option:`CONFIG_BT_SPI` configuration option for more information. -Refer to :ref:`bluetooth-samples` for general Bluetooth information, and +Refer to :zephyr:code-sample-category:`bluetooth` for general Bluetooth information, and to :ref:`96b_carbon_nrf51_bluetooth` for instructions specific to the 96Boards Carbon board. diff --git a/samples/bluetooth/hci_usb/README.rst b/samples/bluetooth/hci_usb/README.rst index 3d88357513a..c8ac294a72f 100644 --- a/samples/bluetooth/hci_usb/README.rst +++ b/samples/bluetooth/hci_usb/README.rst @@ -21,4 +21,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/hci_usb` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/hci_usb_h4/README.rst b/samples/bluetooth/hci_usb_h4/README.rst index 8126c2adf9a..dbce1c85cb1 100644 --- a/samples/bluetooth/hci_usb_h4/README.rst +++ b/samples/bluetooth/hci_usb_h4/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/hci_usb_h4` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/hci_vs_scan_req/README.rst b/samples/bluetooth/hci_vs_scan_req/README.rst index 9c4d3281dc8..a1d3fbd1428 100644 --- a/samples/bluetooth/hci_vs_scan_req/README.rst +++ b/samples/bluetooth/hci_vs_scan_req/README.rst @@ -28,4 +28,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/hci_vs_scan_req` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/ibeacon/README.rst b/samples/bluetooth/ibeacon/README.rst index 38ba89f8f70..9cc00f418f1 100644 --- a/samples/bluetooth/ibeacon/README.rst +++ b/samples/bluetooth/ibeacon/README.rst @@ -29,7 +29,7 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/ibeacon` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details on how +See :zephyr:code-sample-category:`bluetooth` samples for details on how to run the sample inside QEMU. For other boards, build and flash the application as follows: diff --git a/samples/bluetooth/iso_broadcast/README.rst b/samples/bluetooth/iso_broadcast/README.rst index a27f302247f..79eae0e3a7d 100644 --- a/samples/bluetooth/iso_broadcast/README.rst +++ b/samples/bluetooth/iso_broadcast/README.rst @@ -29,4 +29,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/iso_receive` in the Zephyr tree that will scan, establish a periodic advertising synchronization, generate BIGInfo reports and synchronize to BIG events from this sample. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/iso_broadcast_benchmark/README.rst b/samples/bluetooth/iso_broadcast_benchmark/README.rst index cd371c3e11f..bba796a6b46 100644 --- a/samples/bluetooth/iso_broadcast_benchmark/README.rst +++ b/samples/bluetooth/iso_broadcast_benchmark/README.rst @@ -33,7 +33,7 @@ Building and running This sample can be found under :zephyr_file:`samples/bluetooth/iso_broadcast_benchmark` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. Testing diff --git a/samples/bluetooth/iso_central/README.rst b/samples/bluetooth/iso_central/README.rst index 1169425afd4..c3739340705 100644 --- a/samples/bluetooth/iso_central/README.rst +++ b/samples/bluetooth/iso_central/README.rst @@ -44,4 +44,4 @@ the Zephyr tree. ISO Channel 0x200048f8 connected -See :ref:`bluetooth samples section ` for more details. +See :zephyr:code-sample-category:`bluetooth` samples for more details. diff --git a/samples/bluetooth/iso_connected_benchmark/README.rst b/samples/bluetooth/iso_connected_benchmark/README.rst index c4c30f73263..bf489e94306 100644 --- a/samples/bluetooth/iso_connected_benchmark/README.rst +++ b/samples/bluetooth/iso_connected_benchmark/README.rst @@ -32,7 +32,7 @@ Building and running This sample can be found under :zephyr_file:`samples/bluetooth/iso_connected_benchmark` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. Testing diff --git a/samples/bluetooth/iso_peripheral/README.rst b/samples/bluetooth/iso_peripheral/README.rst index f9f0d874add..4ad55953ebb 100644 --- a/samples/bluetooth/iso_peripheral/README.rst +++ b/samples/bluetooth/iso_peripheral/README.rst @@ -64,4 +64,4 @@ This sample can be found under :zephyr_file:`samples/bluetooth/iso_peripheral` i Incoming data channel 0x20000698 len 12 000102...090a0b -See :ref:`bluetooth samples section ` for more details. +See :zephyr:code-sample-category:`bluetooth` samples for more details. diff --git a/samples/bluetooth/iso_receive/README.rst b/samples/bluetooth/iso_receive/README.rst index 85201981c7f..cbd33a20610 100644 --- a/samples/bluetooth/iso_receive/README.rst +++ b/samples/bluetooth/iso_receive/README.rst @@ -30,4 +30,4 @@ another board that will start periodic advertising, create BIG to which this sample will establish periodic advertising synchronization and synchronize to the Broadcast Isochronous Stream. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/mesh/README.rst b/samples/bluetooth/mesh/README.rst index 99514c9e606..f566c071ad2 100644 --- a/samples/bluetooth/mesh/README.rst +++ b/samples/bluetooth/mesh/README.rst @@ -31,7 +31,7 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/mesh` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details on how +See :zephyr:code-sample-category:`bluetooth` samples for details on how to run the sample inside QEMU. For other boards, build and flash the application as follows: diff --git a/samples/bluetooth/mesh_demo/README.rst b/samples/bluetooth/mesh_demo/README.rst index a46f39f49cd..070dd5a45a4 100644 --- a/samples/bluetooth/mesh_demo/README.rst +++ b/samples/bluetooth/mesh_demo/README.rst @@ -42,7 +42,7 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/mesh_demo` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details on how +See :zephyr:code-sample-category:`bluetooth` samples for details on how to run the sample inside QEMU. For other boards, build and flash the application as follows: diff --git a/samples/bluetooth/mesh_provisioner/README.rst b/samples/bluetooth/mesh_provisioner/README.rst index b6f1364b280..10600ef89f3 100644 --- a/samples/bluetooth/mesh_provisioner/README.rst +++ b/samples/bluetooth/mesh_provisioner/README.rst @@ -40,7 +40,7 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/mesh_provisioner` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details on +See :zephyr:code-sample-category:`bluetooth` samples for details on how to run the sample inside QEMU. For other boards, build and flash the application as follows: diff --git a/samples/bluetooth/mtu_update/README.rst b/samples/bluetooth/mtu_update/README.rst index fb5069aa11f..92b445ce600 100644 --- a/samples/bluetooth/mtu_update/README.rst +++ b/samples/bluetooth/mtu_update/README.rst @@ -76,7 +76,7 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/mtu_update` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. If the devices are close enough, the central should connect to the peripheral and send his MTU to the other device. If the MTU exchange succeeds, the central diff --git a/samples/bluetooth/observer/README.rst b/samples/bluetooth/observer/README.rst index 42001e36242..6ef62f3870e 100644 --- a/samples/bluetooth/observer/README.rst +++ b/samples/bluetooth/observer/README.rst @@ -27,4 +27,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/observer` in the Zephyr tree. -See :ref:`Bluetooth samples section ` for details. +See :zephyr:code-sample-category:`Bluetooth samples section ` for details. diff --git a/samples/bluetooth/pbp_public_broadcast_sink/README.rst b/samples/bluetooth/pbp_public_broadcast_sink/README.rst index 72ec4fc3c8f..5a3ae3b2cc0 100644 --- a/samples/bluetooth/pbp_public_broadcast_sink/README.rst +++ b/samples/bluetooth/pbp_public_broadcast_sink/README.rst @@ -15,7 +15,7 @@ a High Quality Public Broadcast Audio Stream configuration. This sample can be found under :zephyr_file:`samples/bluetooth/pbp_public_broadcast_sink` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Requirements ************ diff --git a/samples/bluetooth/pbp_public_broadcast_source/README.rst b/samples/bluetooth/pbp_public_broadcast_source/README.rst index c12c2b762f4..e1c168cedaf 100644 --- a/samples/bluetooth/pbp_public_broadcast_source/README.rst +++ b/samples/bluetooth/pbp_public_broadcast_source/README.rst @@ -15,7 +15,7 @@ every 15 seconds. This sample can be found under :zephyr_file:`samples/bluetooth/pbp_public_broadcast_source` in the Zephyr tree. -Check the :ref:`bluetooth samples section ` for general information. +Check the :zephyr:code-sample-category:`bluetooth` samples for general information. Requirements ************ diff --git a/samples/bluetooth/periodic_adv/README.rst b/samples/bluetooth/periodic_adv/README.rst index 4613abff7be..7f0f1f546a0 100644 --- a/samples/bluetooth/periodic_adv/README.rst +++ b/samples/bluetooth/periodic_adv/README.rst @@ -24,4 +24,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/periodic_sync` in the Zephyr tree that will scan and establish a periodic advertising synchronization to this sample. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/periodic_adv_conn/README.rst b/samples/bluetooth/periodic_adv_conn/README.rst index 5b968f19c40..7ae2095c78b 100644 --- a/samples/bluetooth/periodic_adv_conn/README.rst +++ b/samples/bluetooth/periodic_adv_conn/README.rst @@ -30,4 +30,4 @@ the Zephyr tree. Use the sample found under :zephyr_file:`samples/bluetooth/periodic_sync_conn` in the Zephyr tree that will synchronize and respond to this sample. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/periodic_adv_rsp/README.rst b/samples/bluetooth/periodic_adv_rsp/README.rst index f9e2e6ded00..82575f3d4dd 100644 --- a/samples/bluetooth/periodic_adv_rsp/README.rst +++ b/samples/bluetooth/periodic_adv_rsp/README.rst @@ -36,4 +36,4 @@ the Zephyr tree. Use the sample found under :zephyr_file:`samples/bluetooth/periodic_sync_rsp` in the Zephyr tree that will synchronize and respond to this sample. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/periodic_sync/README.rst b/samples/bluetooth/periodic_sync/README.rst index 72fed008480..8dc424cf9c6 100644 --- a/samples/bluetooth/periodic_sync/README.rst +++ b/samples/bluetooth/periodic_sync/README.rst @@ -25,4 +25,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/periodic_adv` on another board that will start periodic advertising, to which this sample will establish periodic advertising synchronization. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/periodic_sync_conn/README.rst b/samples/bluetooth/periodic_sync_conn/README.rst index 510b01454c0..1ec8aec3d25 100644 --- a/samples/bluetooth/periodic_sync_conn/README.rst +++ b/samples/bluetooth/periodic_sync_conn/README.rst @@ -30,4 +30,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/periodic_adv_conn` on another board that will start periodic advertising and connect to this sample once synced. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/periodic_sync_rsp/README.rst b/samples/bluetooth/periodic_sync_rsp/README.rst index fceb640cca8..9c43ae9c4e4 100644 --- a/samples/bluetooth/periodic_sync_rsp/README.rst +++ b/samples/bluetooth/periodic_sync_rsp/README.rst @@ -38,4 +38,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/periodic_adv_rsp` on another board that will start periodic advertising, which will connect to this sample and transfer the synchronization info. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral/README.rst b/samples/bluetooth/peripheral/README.rst index 33ec088d503..7ce65e8ebd7 100644 --- a/samples/bluetooth/peripheral/README.rst +++ b/samples/bluetooth/peripheral/README.rst @@ -23,4 +23,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_accept_list/README.rst b/samples/bluetooth/peripheral_accept_list/README.rst index a501dd382e5..4f405561466 100644 --- a/samples/bluetooth/peripheral_accept_list/README.rst +++ b/samples/bluetooth/peripheral_accept_list/README.rst @@ -31,4 +31,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_accept_list` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_csc/README.rst b/samples/bluetooth/peripheral_csc/README.rst index 2dcbd143345..aeaa7601db3 100644 --- a/samples/bluetooth/peripheral_csc/README.rst +++ b/samples/bluetooth/peripheral_csc/README.rst @@ -24,4 +24,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_csc` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_dis/README.rst b/samples/bluetooth/peripheral_dis/README.rst index 3d30490009e..44c9591e70b 100644 --- a/samples/bluetooth/peripheral_dis/README.rst +++ b/samples/bluetooth/peripheral_dis/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_dis` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_esp/README.rst b/samples/bluetooth/peripheral_esp/README.rst index e6fdc565040..100d5b88e24 100644 --- a/samples/bluetooth/peripheral_esp/README.rst +++ b/samples/bluetooth/peripheral_esp/README.rst @@ -23,4 +23,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_esp` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_gatt_write/README.rst b/samples/bluetooth/peripheral_gatt_write/README.rst index 5d39f99f3dd..46c22e82690 100644 --- a/samples/bluetooth/peripheral_gatt_write/README.rst +++ b/samples/bluetooth/peripheral_gatt_write/README.rst @@ -23,4 +23,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_gatt_write` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_hids/README.rst b/samples/bluetooth/peripheral_hids/README.rst index 72be337fc88..53a9ec87ede 100644 --- a/samples/bluetooth/peripheral_hids/README.rst +++ b/samples/bluetooth/peripheral_hids/README.rst @@ -29,4 +29,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_hids` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_hr/README.rst b/samples/bluetooth/peripheral_hr/README.rst index c1caa3d90b8..b1e01beda02 100644 --- a/samples/bluetooth/peripheral_hr/README.rst +++ b/samples/bluetooth/peripheral_hr/README.rst @@ -24,4 +24,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_hr` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_ht/README.rst b/samples/bluetooth/peripheral_ht/README.rst index 498b3d38a01..b0bdb080b57 100644 --- a/samples/bluetooth/peripheral_ht/README.rst +++ b/samples/bluetooth/peripheral_ht/README.rst @@ -27,4 +27,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_ht` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_identity/README.rst b/samples/bluetooth/peripheral_identity/README.rst index bb56c48168f..cc67c426801 100644 --- a/samples/bluetooth/peripheral_identity/README.rst +++ b/samples/bluetooth/peripheral_identity/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_identity` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_nus/README.rst b/samples/bluetooth/peripheral_nus/README.rst index bf5be7126b3..419464e87d5 100644 --- a/samples/bluetooth/peripheral_nus/README.rst +++ b/samples/bluetooth/peripheral_nus/README.rst @@ -24,4 +24,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_nus` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_ots/README.rst b/samples/bluetooth/peripheral_ots/README.rst index 1e26dfcf305..83176747188 100644 --- a/samples/bluetooth/peripheral_ots/README.rst +++ b/samples/bluetooth/peripheral_ots/README.rst @@ -22,4 +22,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_ots` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_past/README.rst b/samples/bluetooth/peripheral_past/README.rst index 22190ebb2c3..543771ce092 100644 --- a/samples/bluetooth/peripheral_past/README.rst +++ b/samples/bluetooth/peripheral_past/README.rst @@ -25,4 +25,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/central_past` on another board that will connect to this and transfer a periodic advertisement sync. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/peripheral_sc_only/README.rst b/samples/bluetooth/peripheral_sc_only/README.rst index bbf73b748eb..ba48d3c6a0f 100644 --- a/samples/bluetooth/peripheral_sc_only/README.rst +++ b/samples/bluetooth/peripheral_sc_only/README.rst @@ -24,4 +24,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_sc_only` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/scan_adv/README.rst b/samples/bluetooth/scan_adv/README.rst index 7fbfc54f4c8..d2c476e3fd2 100644 --- a/samples/bluetooth/scan_adv/README.rst +++ b/samples/bluetooth/scan_adv/README.rst @@ -25,4 +25,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/scan_adv` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/st_ble_sensor/README.rst b/samples/bluetooth/st_ble_sensor/README.rst index 88257ed7f05..b1cad9d78e8 100644 --- a/samples/bluetooth/st_ble_sensor/README.rst +++ b/samples/bluetooth/st_ble_sensor/README.rst @@ -29,7 +29,7 @@ To connect click on the device shown in the Device List. After connected, tap LED image on Android to test LED service. Push SW0 button on embedded device to test button service. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. .. _ST Bluetooth LE Sensor Android app: https://play.google.com/store/apps/details?id=com.st.bluems diff --git a/samples/bluetooth/tmap_bmr/README.rst b/samples/bluetooth/tmap_bmr/README.rst index 356ab6f2abf..2f7f5df2bab 100644 --- a/samples/bluetooth/tmap_bmr/README.rst +++ b/samples/bluetooth/tmap_bmr/README.rst @@ -19,4 +19,4 @@ Building and Running ******************** This sample can be found under :zephyr_file:`samples/bluetooth/tmap_bmr` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/tmap_bms/README.rst b/samples/bluetooth/tmap_bms/README.rst index a5f19fdbf45..ac648ead315 100644 --- a/samples/bluetooth/tmap_bms/README.rst +++ b/samples/bluetooth/tmap_bms/README.rst @@ -20,4 +20,4 @@ Building and Running ******************** This sample can be found under :zephyr_file:`samples/bluetooth/tmap_bms` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/tmap_central/README.rst b/samples/bluetooth/tmap_central/README.rst index 8195b79ecce..9a89fb87ee5 100644 --- a/samples/bluetooth/tmap_central/README.rst +++ b/samples/bluetooth/tmap_central/README.rst @@ -20,4 +20,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/tmap_central` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/bluetooth/tmap_peripheral/README.rst b/samples/bluetooth/tmap_peripheral/README.rst index d0ebd02e548..b0888224537 100644 --- a/samples/bluetooth/tmap_peripheral/README.rst +++ b/samples/bluetooth/tmap_peripheral/README.rst @@ -20,4 +20,4 @@ Building and Running This sample can be found under :zephyr_file:`samples/bluetooth/tmap_peripheral` in the Zephyr tree. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/boards/96boards/argonkey/index.rst b/samples/boards/96boards/argonkey/index.rst index 2713379253d..5720889c884 100644 --- a/samples/boards/96boards/argonkey/index.rst +++ b/samples/boards/96boards/argonkey/index.rst @@ -1,10 +1,5 @@ -.. _argonkey-samples: +.. zephyr:code-sample-category:: 96b_argonkey + :name: 96Boards ArgonKey + :show-listing: -Argonkey Samples -################ - -.. toctree:: - :maxdepth: 1 - :glob: - - */* + Samples that demonstrate some board-specific features on 96Boards ArgonKey. diff --git a/samples/boards/96boards/index.rst b/samples/boards/96boards/index.rst index 0a024b7cf27..3cab6851eca 100644 --- a/samples/boards/96boards/index.rst +++ b/samples/boards/96boards/index.rst @@ -1,10 +1,5 @@ -.. _96boards_samples: +.. zephyr:code-sample-category:: 96boards + :name: 96Boards + :show-listing: -96Boards -======== - -.. toctree:: - :titlesonly: - :glob: - - */* + These samples showcase the use of 96Boards in Zephyr. diff --git a/samples/boards/arc_secure_services/README.rst b/samples/boards/arc_secure_services/README.rst index e63a9b9e910..a7744af7812 100644 --- a/samples/boards/arc_secure_services/README.rst +++ b/samples/boards/arc_secure_services/README.rst @@ -1,3 +1,5 @@ +:orphan: + .. _arc_secure_service: ARC Secure Service diff --git a/samples/boards/bbc/index.rst b/samples/boards/bbc/index.rst index 73d1dc1adba..f6b69ecd3d7 100644 --- a/samples/boards/bbc/index.rst +++ b/samples/boards/bbc/index.rst @@ -1,11 +1,5 @@ -.. _bbc_samples: +.. zephyr:code-sample-category:: bbc + :name: BBC + :show-listing: -BBC -=== - -.. toctree:: - :titlesonly: - :maxdepth: 1 - :glob: - - */* + These samples showcase the use of BBC boards in Zephyr. diff --git a/samples/boards/bbc/microbit/microbit.rst b/samples/boards/bbc/microbit/microbit.rst index 3a325452a49..907a63577b0 100644 --- a/samples/boards/bbc/microbit/microbit.rst +++ b/samples/boards/bbc/microbit/microbit.rst @@ -1,10 +1,5 @@ -.. _microbit-samples: +.. zephyr:code-sample-category:: bbc_microbit + :name: BBC micro:bit + :show-listing: -BBC micro:bit Samples -##################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate some board-specific features on BBC micro:bit. diff --git a/samples/boards/boards.rst b/samples/boards/boards.rst index c5433a6a9fe..424101b8625 100644 --- a/samples/boards/boards.rst +++ b/samples/boards/boards.rst @@ -1,11 +1,5 @@ -.. _board-specific-samples: +.. zephyr:code-sample-category:: boards + :name: Boards + :show-listing: -Board-specific samples -###################### - -.. toctree:: - :titlesonly: - :maxdepth: 2 - :glob: - - */* + These samples demonstrate some board-specific features in Zephyr. diff --git a/samples/boards/enjoydigital/index.rst b/samples/boards/enjoydigital/index.rst index 9b75eca52e1..d0df43c338a 100644 --- a/samples/boards/enjoydigital/index.rst +++ b/samples/boards/enjoydigital/index.rst @@ -1,10 +1,6 @@ -.. _enjoydigital_samples: +.. zephyr:code-sample-category:: enjoydigital + :name: EnjoyDigital + :show-listing: + :glob: **/* -EnjoyDigital -============ - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of EnjoyDigital boards in Zephyr. diff --git a/samples/boards/enjoydigital/litex/i2s/README.rst b/samples/boards/enjoydigital/litex/i2s/README.rst index 3e0e35ba800..eb8a0cde6af 100644 --- a/samples/boards/enjoydigital/litex/i2s/README.rst +++ b/samples/boards/enjoydigital/litex/i2s/README.rst @@ -1,3 +1,5 @@ +:orphan: + .. _i2s_litex_example: ##################### diff --git a/samples/boards/espressif/index.rst b/samples/boards/espressif/index.rst index 525e8e831a9..56a8eaba580 100644 --- a/samples/boards/espressif/index.rst +++ b/samples/boards/espressif/index.rst @@ -1,10 +1,5 @@ -.. _espressif_samples: +.. zephyr:code-sample-category:: espressif + :name: Espressif ESP32 boards + :show-listing: -Espressif -========= - -.. toctree:: - :titlesonly: - :glob: - - **/* + Samples that demonstrate the use of Espressif ESP32 boards in Zephyr. diff --git a/samples/boards/google/index.rst b/samples/boards/google/index.rst index ba16924e063..38765be0389 100644 --- a/samples/boards/google/index.rst +++ b/samples/boards/google/index.rst @@ -1,10 +1,6 @@ -.. _google_samples: +.. zephyr:code-sample-category:: Google + :name: Google + :show-listing: + :glob: **/* -Google -====== - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of Google boards in Zephyr. diff --git a/samples/boards/intel/index.rst b/samples/boards/intel/index.rst index 737134a5529..3f2ffe22145 100644 --- a/samples/boards/intel/index.rst +++ b/samples/boards/intel/index.rst @@ -1,10 +1,6 @@ -.. _intel_samples: +.. zephyr:code-sample-category:: intel + :name: Intel + :show-listing: + :glob: **/* -Intel -===== - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of Intel boards in Zephyr. diff --git a/samples/boards/microchip/index.rst b/samples/boards/microchip/index.rst index 85e4926721e..cabaa322cca 100644 --- a/samples/boards/microchip/index.rst +++ b/samples/boards/microchip/index.rst @@ -1,10 +1,5 @@ -.. _microchip_samples: +.. zephyr:code-sample-category:: microchip + :name: Microchip + :show-listing: -Microchip -========= - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of Microchip boards in Zephyr. diff --git a/samples/boards/microchip/mec15xxevb_assy6853/mec15xxevb_assy6853.rst b/samples/boards/microchip/mec15xxevb_assy6853/mec15xxevb_assy6853.rst index e4337f43181..6961892cc63 100644 --- a/samples/boards/microchip/mec15xxevb_assy6853/mec15xxevb_assy6853.rst +++ b/samples/boards/microchip/mec15xxevb_assy6853/mec15xxevb_assy6853.rst @@ -1,10 +1,5 @@ -.. _mec15xxevb_assy6853-samples: +.. zephyr:code-sample-category:: mec15xxevb_assy6853 + :name: MEC15xxEVB Reference Board + :show-listing: -MEC15xxEVB Reference Board Samples -################################## - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples showcase the use of MEC15xxEVB Reference Board in Zephyr. diff --git a/samples/boards/nordic/index.rst b/samples/boards/nordic/index.rst index 01d44950439..9559a68ea52 100644 --- a/samples/boards/nordic/index.rst +++ b/samples/boards/nordic/index.rst @@ -1,10 +1,6 @@ -.. _nordic_samples: +.. zephyr:code-sample-category:: nordic + :name: Nordic Semiconductor + :show-listing: + :glob: **/* -Nordic Semiconductor -==================== - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of Nordic Semiconductor boards in Zephyr. diff --git a/samples/boards/nordic/mesh/onoff-app/README.rst b/samples/boards/nordic/mesh/onoff-app/README.rst index 64051709a22..c09498b1103 100644 --- a/samples/boards/nordic/mesh/onoff-app/README.rst +++ b/samples/boards/nordic/mesh/onoff-app/README.rst @@ -97,4 +97,4 @@ Group addresses are not supported. This application was derived from the sample mesh skeleton at :zephyr_file:`samples/bluetooth/mesh`. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/boards/nordic/mesh/onoff_level_lighting_vnd_app/README.rst b/samples/boards/nordic/mesh/onoff_level_lighting_vnd_app/README.rst index 1139581efe2..5392b9c5407 100644 --- a/samples/boards/nordic/mesh/onoff_level_lighting_vnd_app/README.rst +++ b/samples/boards/nordic/mesh/onoff_level_lighting_vnd_app/README.rst @@ -114,4 +114,4 @@ Group addresses are not supported. This application was derived from the sample mesh skeleton at :zephyr_file:`samples/bluetooth/mesh`. -See :ref:`bluetooth samples section ` for details. +See :zephyr:code-sample-category:`bluetooth` samples for details. diff --git a/samples/boards/nxp/index.rst b/samples/boards/nxp/index.rst index 318bc81e0bb..dba7cb6e829 100644 --- a/samples/boards/nxp/index.rst +++ b/samples/boards/nxp/index.rst @@ -1,10 +1,6 @@ -.. _nxp_samples: +.. zephyr:code-sample-category:: nxp + :name: NXP + :show-listing: + :glob: **/* -NXP -=== - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of NXP boards in Zephyr. diff --git a/samples/boards/phytec/index.rst b/samples/boards/phytec/index.rst index 81f1d5f2f38..3402c63f44e 100644 --- a/samples/boards/phytec/index.rst +++ b/samples/boards/phytec/index.rst @@ -1,10 +1,5 @@ -.. _phytec_samples: +.. zephyr:code-sample-category:: phytec + :name: PHYTEC + :show-listing: -PHYTEC -====== - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of PHYTEC boards in Zephyr. diff --git a/samples/boards/phytec/reel_board/index.rst b/samples/boards/phytec/reel_board/index.rst new file mode 100644 index 00000000000..f43c8677bb9 --- /dev/null +++ b/samples/boards/phytec/reel_board/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: reelboard + :name: reel board + :show-listing: + + Samples that demonstrate some board-specific features on reel board. diff --git a/samples/boards/phytec/reel_board/mesh_badge/README.rst b/samples/boards/phytec/reel_board/mesh_badge/README.rst index ef00511edd4..74d30f61081 100644 --- a/samples/boards/phytec/reel_board/mesh_badge/README.rst +++ b/samples/boards/phytec/reel_board/mesh_badge/README.rst @@ -7,7 +7,7 @@ Overview ******** -This sample app for the reel board showcases Bluetooth Mesh +This sample app for the reel board showcases Bluetooth Mesh. The app starts off as a regular Bluetooth GATT peripheral application. Install the "nRF Connect" app on your phone (available both for diff --git a/samples/boards/quicklogic/index.rst b/samples/boards/quicklogic/index.rst index 9de957464e2..bf8e563ee15 100644 --- a/samples/boards/quicklogic/index.rst +++ b/samples/boards/quicklogic/index.rst @@ -1,10 +1,5 @@ -.. _quicklogic_samples: +.. zephyr:code-sample-category:: quicklogic + :name: QuickLogic + :show-listing: -QuickLogic Corp. -================ - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of QuickLogic boards in Zephyr. diff --git a/samples/boards/st/bluetooth/index.rst b/samples/boards/st/bluetooth/index.rst new file mode 100644 index 00000000000..4e791b6a9bc --- /dev/null +++ b/samples/boards/st/bluetooth/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: stm32_bluetooth + :name: Bluetooth + :show-listing: + + Samples that demonstrate the use of Bluetooth on STM32 boards. diff --git a/samples/boards/st/index.rst b/samples/boards/st/index.rst index 06ccf192ab6..2fbf890669d 100644 --- a/samples/boards/st/index.rst +++ b/samples/boards/st/index.rst @@ -1,10 +1,6 @@ -.. _st_samples: +.. zephyr:code-sample-category:: st + :name: STMicroelectronics + :show-listing: + :glob: **/* -STMicroelectronics -================== - -.. toctree:: - :titlesonly: - :glob: - - **/* + Samples that demonstrate some board-specific features on STM32 boards. diff --git a/samples/boards/st/power_mgmt/index.rst b/samples/boards/st/power_mgmt/index.rst new file mode 100644 index 00000000000..3ab69379b60 --- /dev/null +++ b/samples/boards/st/power_mgmt/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: stm32_pm + :name: Power Management + :show-listing: + + Samples that demonstrate the use of power management features on STM32 boards. diff --git a/samples/boards/ti/index.rst b/samples/boards/ti/index.rst index ad970714f40..349b72f0801 100644 --- a/samples/boards/ti/index.rst +++ b/samples/boards/ti/index.rst @@ -1,10 +1,6 @@ -.. _ti_samples: +.. zephyr:code-sample-category:: ti + :name: Texas Instruments + :show-listing: + :glob: **/* -Texas Instruments -================= - -.. toctree:: - :titlesonly: - :glob: - - **/* + These samples showcase the use of Texas Instruments boards in Zephyr. diff --git a/samples/classic.rst b/samples/classic.rst deleted file mode 100644 index 707d1a590eb..00000000000 --- a/samples/classic.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _classic_samples: - -Classic Samples -############### - -The following are samples that can be run on any of the supported -platforms: - -.. toctree:: - :maxdepth: 1 - :glob: - - hello_world/* - synchronization/* - philosophers/* diff --git a/samples/cpp/cpp.rst b/samples/cpp/cpp.rst index aeecebadcca..4722683a9ee 100644 --- a/samples/cpp/cpp.rst +++ b/samples/cpp/cpp.rst @@ -1,10 +1,5 @@ -.. _cpp-samples: +.. zephyr:code-sample-category:: cpp + :name: C++ + :show-listing: -C++ Samples -########### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to write Zephyr applications in C++. diff --git a/samples/drivers/adc/index.rst b/samples/drivers/adc/index.rst new file mode 100644 index 00000000000..c1e9a2abfa6 --- /dev/null +++ b/samples/drivers/adc/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: adc + :name: ADC + :show-listing: + + These samples demonstrate how to use the ADC driver API. diff --git a/samples/drivers/audio/index.rst b/samples/drivers/audio/index.rst new file mode 100644 index 00000000000..46e68b287df --- /dev/null +++ b/samples/drivers/audio/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: audio + :name: Audio + :show-listing: + + These sample demonstrate how to use the :ref:`Audio driver ` API. diff --git a/samples/drivers/can/index.rst b/samples/drivers/can/index.rst new file mode 100644 index 00000000000..c085669fbbb --- /dev/null +++ b/samples/drivers/can/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: can + :name: Controller Area Network (CAN) + :show-listing: + + These samples demonstrate how to use the :ref:`can` driver API. diff --git a/samples/drivers/counter/index.rst b/samples/drivers/counter/index.rst new file mode 100644 index 00000000000..ff5ebf8932d --- /dev/null +++ b/samples/drivers/counter/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: counter + :name: Counter + :show-listing: + + These samples demonstrate how to use the :ref:`counter_api` driver API. diff --git a/samples/drivers/drivers.rst b/samples/drivers/drivers.rst index 84c5426094a..24b9578a6e9 100644 --- a/samples/drivers/drivers.rst +++ b/samples/drivers/drivers.rst @@ -1,13 +1,6 @@ -.. _driver-samples: +.. zephyr:code-sample-category:: drivers + :name: Drivers + :show-listing: + :live-search: -Driver Samples -############## - -The following samples demonstrate how to use various drivers supported -by Zephyr. - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use various drivers supported by Zephyr. diff --git a/samples/drivers/ethernet/index.rst b/samples/drivers/ethernet/index.rst new file mode 100644 index 00000000000..8b46ca0f725 --- /dev/null +++ b/samples/drivers/ethernet/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: ethernet + :name: Ethernet + :show-listing: + + These samples demonstrate how to use the :ref:`Ethernet ` driver API. diff --git a/samples/drivers/fpga/index.rst b/samples/drivers/fpga/index.rst new file mode 100644 index 00000000000..395a953740b --- /dev/null +++ b/samples/drivers/fpga/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: fpga + :name: FPGA + :show-listing: + + These samples demonstrate how to use the FPGA driver API. diff --git a/samples/drivers/haptics/README.rst b/samples/drivers/haptics/README.rst new file mode 100644 index 00000000000..d4e08884b80 --- /dev/null +++ b/samples/drivers/haptics/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: haptics + :name: Haptics + :show-listing: + + These samples demonstrate how to use the :ref:`haptics_api` driver API. diff --git a/samples/drivers/i2c/README.rst b/samples/drivers/i2c/README.rst new file mode 100644 index 00000000000..9e934001301 --- /dev/null +++ b/samples/drivers/i2c/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: i2c + :name: Inter-Integrated Circuit (I2C) Bus + :show-listing: + + These samples demonstrate how to use the :ref:`I2C ` driver API. diff --git a/samples/drivers/i2s/README.rst b/samples/drivers/i2s/README.rst new file mode 100644 index 00000000000..8243878f3a5 --- /dev/null +++ b/samples/drivers/i2s/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: i2s + :name: I2S + :show-listing: + + These samples demonstrate how to use the I2S driver API. diff --git a/samples/drivers/ipm/README.rst b/samples/drivers/ipm/README.rst new file mode 100644 index 00000000000..e3a1f40a6fb --- /dev/null +++ b/samples/drivers/ipm/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: ipm + :name: Inter-Processor Mailbox (IPM) + :show-listing: + + These samples demonstrate how to use the :ref:`IPM ` driver API. diff --git a/samples/drivers/led/index.rst b/samples/drivers/led/index.rst new file mode 100644 index 00000000000..30dbf504131 --- /dev/null +++ b/samples/drivers/led/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: led + :name: Light-Emitting Diode (LED) + :show-listing: + + These samples demonstrate how to use the LED driver API. diff --git a/samples/drivers/lora/index.rst b/samples/drivers/lora/index.rst new file mode 100644 index 00000000000..8156d9d2638 --- /dev/null +++ b/samples/drivers/lora/index.rst @@ -0,0 +1,6 @@ +.. zephyr:code-sample-category:: lora + :name: LoRa + :show-listing: + + These samples demonstrate how to use :ref:`LoRa ` for long-range wireless + communication. diff --git a/samples/drivers/misc/README.rst b/samples/drivers/misc/README.rst new file mode 100644 index 00000000000..2c4101f51d1 --- /dev/null +++ b/samples/drivers/misc/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: misc_drivers + :name: Miscellaneous + :show-listing: + + These samples demonstrate how to use miscellaneous driver APIs. diff --git a/samples/drivers/mspi/index.rst b/samples/drivers/mspi/index.rst new file mode 100644 index 00000000000..3cd994ba127 --- /dev/null +++ b/samples/drivers/mspi/index.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: mspi + :name: Multi-bit SPI Bus (MSPI) + :show-listing: + + These samples demonstrate how to use the :ref:`MSPI ` driver API. diff --git a/samples/drivers/uart/README.rst b/samples/drivers/uart/README.rst new file mode 100644 index 00000000000..4501bd73a3d --- /dev/null +++ b/samples/drivers/uart/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: uart + :name: Universal Asynchronous Receiver-Transmitter (UART) + :show-listing: + + These samples demonstrate how to use the :ref:`UART ` driver API. diff --git a/samples/drivers/video/video.rst b/samples/drivers/video/video.rst index 326a337f05b..99a4b24449e 100644 --- a/samples/drivers/video/video.rst +++ b/samples/drivers/video/video.rst @@ -1,10 +1,5 @@ -.. _video-samples: +.. zephyr:code-sample-category:: video + :name: Video + :show-listing: -Video Samples -############# - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use the :ref:`video ` driver API. diff --git a/samples/drivers/virtualization/index.rst b/samples/drivers/virtualization/index.rst new file mode 100644 index 00000000000..0716ac7bd37 --- /dev/null +++ b/samples/drivers/virtualization/index.rst @@ -0,0 +1,6 @@ +.. zephyr:code-sample-category:: virtualization + :name: Virtualization + :show-listing: + :glob: **/* + + These samples demonstrate some of the virtualization capabilities of Zephyr. diff --git a/samples/drivers/w1/README.rst b/samples/drivers/w1/README.rst new file mode 100644 index 00000000000..7025ee7e0b4 --- /dev/null +++ b/samples/drivers/w1/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: w1 + :name: 1-Wire + :show-listing: + + These samples demonstrate how to use the :ref:`1-Wire ` driver API. diff --git a/samples/fuel_gauge/fuel_gauge.rst b/samples/fuel_gauge/fuel_gauge.rst index 979180fb72b..01df07c8aaa 100644 --- a/samples/fuel_gauge/fuel_gauge.rst +++ b/samples/fuel_gauge/fuel_gauge.rst @@ -1,10 +1,5 @@ -.. _fuel_gauge-samples: +.. zephyr:code-sample-category:: fuel_gauge + :name: Fuel Gauge + :show-listing: -Fuel Gauge Samples -################## - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that show how to interact with :ref:`fuel_gauge_api`. diff --git a/samples/fuel_gauge/max17048/README.rst b/samples/fuel_gauge/max17048/README.rst index f2fd2618220..cdb08e1e4ec 100644 --- a/samples/fuel_gauge/max17048/README.rst +++ b/samples/fuel_gauge/max17048/README.rst @@ -1,7 +1,7 @@ -.. _MAX17048_sample: +.. zephyr:code-sample:: max17048 + :name: MAX17048 Li-Ion battery fuel gauge -MAX17048 Li-Ion battery fuel gauge -################################### + Read battery percentage and power status using MAX17048 fuel gauge. Overview ******** diff --git a/samples/index.rst b/samples/index.rst index d8f28152c73..40151ea0915 100644 --- a/samples/index.rst +++ b/samples/index.rst @@ -1,35 +1,23 @@ -.. _samples-and-demos: +.. zephyr:code-sample-category:: samples + :name: Samples and Demos -Samples and Demos -################# +Zephyr offers a comprehensive collection of samples and demos that highlight the features of the +kernel and its subsystems. +These samples are crafted to be simple and easy to understand, serving as a starting point for your +own projects. + +We welcome contributions of new samples to the project and you are encouraged to read more about +the :ref:`definition_and_criteria` if you are interested in submitting your own sample. + +.. zephyr:code-sample-listing:: + :categories: samples + :live-search: .. toctree:: :titlesonly: - :maxdepth: 2 + :maxdepth: 1 + :hidden: :glob: sample_definition_and_criteria - classic - basic/* - userspace/* - sysbuild/* - subsys/subsys.rst - net/net.rst - bluetooth/bluetooth.rst - sensor/* - arch/* - boards/* - drivers/drivers.rst - application_development/* - shields/* - cpp/* - posix/* - kernel/* - tfm_integration/tfm_integration.rst - modules/* - fuel_gauge/* - -.. comment - To add a new sample document, please use the template available under - ``doc/templates/sample.tmpl`` diff --git a/samples/kernel/condition_variables/simple/README.rst b/samples/kernel/condition_variables/simple/README.rst index 2977b72cc97..b3db950dd58 100644 --- a/samples/kernel/condition_variables/simple/README.rst +++ b/samples/kernel/condition_variables/simple/README.rst @@ -1,3 +1,5 @@ +:orphan: + .. _samples_kernel_simple_condition_variables: Condition Variables diff --git a/samples/kernel/index.rst b/samples/kernel/index.rst index 13c31ecb31a..710a4bda95c 100644 --- a/samples/kernel/index.rst +++ b/samples/kernel/index.rst @@ -1,10 +1,6 @@ -.. _kernel-samples: +.. zephyr:code-sample-category:: kernel + :name: Kernel and Scheduler + :show-listing: + :glob: **/* -Various Kernel and Scheduler Samples -#################################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use various kernel and scheduler features. diff --git a/samples/modules/cmsis_dsp/cmsis_dsp.rst b/samples/modules/cmsis_dsp/cmsis_dsp.rst index dce6b8cad96..0506721f4e0 100644 --- a/samples/modules/cmsis_dsp/cmsis_dsp.rst +++ b/samples/modules/cmsis_dsp/cmsis_dsp.rst @@ -1,12 +1,6 @@ -CMSIS-DSP -######### +.. zephyr:code-sample-category:: cmsis_dsp + :name: CMSIS-DSP + :show-listing: -These samples demonstrate how to use the CMSIS-DSP module to perform signal processing operations -in Zephyr. - -.. toctree:: - :titlesonly: - :glob: - :maxdepth: 1 - - */* + These samples demonstrate how to use the CMSIS-DSP module to perform signal processing operations + in Zephyr. diff --git a/samples/modules/compression/compression.rst b/samples/modules/compression/compression.rst index 9cc3cd3d3c3..095c326584e 100644 --- a/samples/modules/compression/compression.rst +++ b/samples/modules/compression/compression.rst @@ -1,10 +1,3 @@ -.. _compression-samples: - -Compression Samples -################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* +.. zephyr:code-sample-category:: compression + :name: Compression + :show-listing: diff --git a/samples/modules/index.rst b/samples/modules/index.rst index c40b9fe7850..8c5c9b47aa3 100644 --- a/samples/modules/index.rst +++ b/samples/modules/index.rst @@ -1,11 +1,5 @@ -.. _module-samples: +.. zephyr:code-sample-category:: modules + :name: External modules + :show-listing: -External Module Samples -####################### - -.. toctree:: - :titlesonly: - :maxdepth: 2 - :glob: - - */* + These samples demonstrate the use of external modules in Zephyr. diff --git a/samples/modules/lvgl/lvgl.rst b/samples/modules/lvgl/lvgl.rst index 736ddd1a00b..fa2ca5459c7 100644 --- a/samples/modules/lvgl/lvgl.rst +++ b/samples/modules/lvgl/lvgl.rst @@ -1,13 +1,5 @@ -.. _lvgl_samples: +.. zephyr:code-sample-category:: lvgl + :name: LVGL + :show-listing: -LVGL -#### - -These samples demonstrate how to build graphical user interfaces using LVGL in Zephyr. - -.. toctree:: - :titlesonly: - :glob: - :maxdepth: 1 - - **/* + These samples demonstrate how to build graphical user interfaces using LVGL in Zephyr. diff --git a/samples/modules/tflite-micro/tflite-micro.rst b/samples/modules/tflite-micro/tflite-micro.rst index 861618a645b..316791c7271 100644 --- a/samples/modules/tflite-micro/tflite-micro.rst +++ b/samples/modules/tflite-micro/tflite-micro.rst @@ -1,13 +1,5 @@ -.. _tflitemicro_samples: +.. zephyr:code-sample-category:: tflite-micro + :name: TensorFlow Lite for Microcontrollers + :show-listing: -TensorFlow Lite for Microcontrollers -#################################### - -These samples demonstrate how to use TensorFlow Lite for Microcontrollers in Zephyr. - -.. toctree:: - :titlesonly: - :glob: - :maxdepth: 1 - - **/* + These samples demonstrate how to use TensorFlow Lite for Microcontrollers in Zephyr. diff --git a/samples/modules/thrift/thrift.rst b/samples/modules/thrift/thrift.rst index 3ea28f1831b..9d6f86734d3 100644 --- a/samples/modules/thrift/thrift.rst +++ b/samples/modules/thrift/thrift.rst @@ -1,11 +1,5 @@ -Apache Thrift -============= +.. zephyr:code-sample-category:: thrift + :name: Apache Thrift + :show-listing: -These samples demonstrate how to use Apache Thrift in Zephyr. - -.. toctree:: - :titlesonly: - :glob: - :maxdepth: 1 - - */* + These samples demonstrate how to use Apache Thrift in Zephyr. diff --git a/samples/net/cloud/README.rst b/samples/net/cloud/README.rst new file mode 100644 index 00000000000..8bc388d36f1 --- /dev/null +++ b/samples/net/cloud/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: cloud + :name: IoT Cloud + :show-listing: + + These samples demonstrate how to connect Zephyr devices to various IoT cloud services. diff --git a/samples/net/net.rst b/samples/net/net.rst index cbccd04fdf8..7359b8c171b 100644 --- a/samples/net/net.rst +++ b/samples/net/net.rst @@ -1,10 +1,6 @@ -.. _networking-samples: +.. zephyr:code-sample-category:: net + :name: Networking + :show-listing: + :live-search: -Networking Samples -################## - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use the networking subsystem. diff --git a/samples/net/openthread/coprocessor/README.rst b/samples/net/openthread/coprocessor/README.rst index 5fbf49c8368..373fbdf8f59 100644 --- a/samples/net/openthread/coprocessor/README.rst +++ b/samples/net/openthread/coprocessor/README.rst @@ -1,3 +1,5 @@ +:orphan: + .. zephyr:code-sample:: coprocessor :name: OpenThread co-processor :relevant-api: openthread diff --git a/samples/net/sockets/sockets.rst b/samples/net/sockets/sockets.rst new file mode 100644 index 00000000000..edeaab1ffcc --- /dev/null +++ b/samples/net/sockets/sockets.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: sockets + :name: Sockets API + :show-listing: + + These samples demonstrate how to use the :ref:`bsd_sockets_interface` API. diff --git a/samples/posix/posix.rst b/samples/posix/posix.rst index f7d026eb2cd..2e975069b66 100644 --- a/samples/posix/posix.rst +++ b/samples/posix/posix.rst @@ -1,10 +1,5 @@ -.. _posix-samples: +.. zephyr:code-sample-category:: posix + :name: POSIX API + :show-listing: -POSIX API Samples -################# - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use the :ref:`POSIX API ` in Zephyr. diff --git a/samples/sensor/sensor.rst b/samples/sensor/sensor.rst index 567574977dc..dfc882c2fab 100644 --- a/samples/sensor/sensor.rst +++ b/samples/sensor/sensor.rst @@ -1,10 +1,5 @@ -.. _sensor-samples: +.. zephyr:code-sample-category:: sensors + :name: Sensors + :show-listing: -Sensor Samples -############## - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use various sensors supported by Zephyr. diff --git a/samples/shields/npm1300_ek/doc/index.rst b/samples/shields/npm1300_ek/doc/index.rst index 4761ba6f8a2..be2e8db34cf 100644 --- a/samples/shields/npm1300_ek/doc/index.rst +++ b/samples/shields/npm1300_ek/doc/index.rst @@ -1,7 +1,7 @@ -.. _npm1300_ek_sample: +.. zephyr:code-sample:: npm1300_ek + :name: nPM1300 EK -nPM1300 EK sample -################# + Interact with the nPM1300 PMIC using the shell interface. Overview ******** diff --git a/samples/shields/npm6001_ek/doc/index.rst b/samples/shields/npm6001_ek/doc/index.rst index 13e4f64ce29..394adb2c56b 100644 --- a/samples/shields/npm6001_ek/doc/index.rst +++ b/samples/shields/npm6001_ek/doc/index.rst @@ -1,7 +1,7 @@ -.. _npm6001_ek_sample: +.. zephyr:code-sample:: npm6001_ek + :name: nPM6001 EK -nPM6001 EK sample -################# + Interact with the nPM6001 PMIC using the shell interface. Overview ******** diff --git a/samples/shields/shields.rst b/samples/shields/shields.rst index 52f436fd93c..f1cea031eeb 100644 --- a/samples/shields/shields.rst +++ b/samples/shields/shields.rst @@ -1,10 +1,6 @@ -.. _shields-samples: +.. zephyr:code-sample-category:: shields + :name: Shields + :show-listing: + :glob: **/* -Shields Samples -############### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the use of shields in Zephyr. diff --git a/samples/shields/x_nucleo_iks01a2/README.rst b/samples/shields/x_nucleo_iks01a2/README.rst new file mode 100644 index 00000000000..1a5c865570e --- /dev/null +++ b/samples/shields/x_nucleo_iks01a2/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: x_nucleo_iks01a2 + :name: X-NUCLEO-IKS01A2 shield + :show-listing: + + These samples showcase various features of the X-NUCLEO-IKS01A2 shield. diff --git a/samples/shields/x_nucleo_iks01a3/README.rst b/samples/shields/x_nucleo_iks01a3/README.rst new file mode 100644 index 00000000000..35f4cdd94e2 --- /dev/null +++ b/samples/shields/x_nucleo_iks01a3/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: x_nucleo_iks01a3 + :name: X-NUCLEO-IKS01A3 shield + :show-listing: + + These samples showcase various features of the X-NUCLEO-IKS01A3 shield. diff --git a/samples/shields/x_nucleo_iks02a1/README.rst b/samples/shields/x_nucleo_iks02a1/README.rst new file mode 100644 index 00000000000..59aec43bcff --- /dev/null +++ b/samples/shields/x_nucleo_iks02a1/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: x_nucleo_iks02a1 + :name: X-NUCLEO-IKS02A1 shield + :show-listing: + + These samples showcase various features of the X-NUCLEO-IKS02A1 shield. diff --git a/samples/shields/x_nucleo_iks4a1/README.rst b/samples/shields/x_nucleo_iks4a1/README.rst new file mode 100644 index 00000000000..4e0861f42aa --- /dev/null +++ b/samples/shields/x_nucleo_iks4a1/README.rst @@ -0,0 +1,5 @@ +.. zephyr:code-sample-category:: x_nucleo_iks4a1 + :name: X-NUCLEO-IKS4A1 shield + :show-listing: + + These samples showcase various features of the X-NUCLEO-IKS4A1 shield. diff --git a/samples/subsys/bindesc/bindesc.rst b/samples/subsys/bindesc/bindesc.rst index 105d6f80dc8..5efd18abbe6 100644 --- a/samples/subsys/bindesc/bindesc.rst +++ b/samples/subsys/bindesc/bindesc.rst @@ -1,10 +1,5 @@ -.. _bindesc_samples: +.. zephyr:code-sample-category:: bindesc + :name: Binary Descriptor + :show-listing: -Binary Descriptor Samples -######################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate how to use :ref:`binary_descriptors`. diff --git a/samples/subsys/canbus/canbus.rst b/samples/subsys/canbus/canbus.rst index 8772cc5ff9a..cfc8c75756a 100644 --- a/samples/subsys/canbus/canbus.rst +++ b/samples/subsys/canbus/canbus.rst @@ -8,3 +8,10 @@ Controller Area Network (CAN) Bus Samples :glob: **/* + + +.. zephyr:code-sample-category:: canbus + :name: Controller Area Network (CAN) Bus + :show-listing: + + Samples that demonstrate the :ref:`Controller Area Network (CAN) bus ` features. diff --git a/samples/subsys/console/console.rst b/samples/subsys/console/console.rst index eb9a5127660..5ad7b1a6748 100644 --- a/samples/subsys/console/console.rst +++ b/samples/subsys/console/console.rst @@ -1,10 +1,5 @@ -.. _console-samples: +.. zephyr:code-sample-category:: console + :name: Console + :show-listing: -Console Samples -############### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`console` subsystem. diff --git a/samples/subsys/debug/index.rst b/samples/subsys/debug/index.rst index 3e28648b1f5..8c73a163e87 100644 --- a/samples/subsys/debug/index.rst +++ b/samples/subsys/debug/index.rst @@ -1,10 +1,5 @@ -.. _debug-samples: +.. zephyr:code-sample-category:: debug + :name: Debug + :show-listing: -Debug Samples -################# - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate advanced debugging features. diff --git a/samples/subsys/display/display.rst b/samples/subsys/display/display.rst index 955eeaaea5b..21dc6ebf5d7 100644 --- a/samples/subsys/display/display.rst +++ b/samples/subsys/display/display.rst @@ -1,10 +1,5 @@ -.. _display-samples: +.. zephyr:code-sample-category:: display + :name: Display + :show-listing: -Display Samples -############### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use the display subsystem. diff --git a/samples/subsys/fs/fs.rst b/samples/subsys/fs/fs.rst index 0875b1ea0bd..0ba8ed68016 100644 --- a/samples/subsys/fs/fs.rst +++ b/samples/subsys/fs/fs.rst @@ -1,10 +1,5 @@ -.. _fs-samples: +.. zephyr:code-sample-category:: fs + :name: File Systems + :show-listing: -FS Samples -########## - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate how to interact with :ref:`file_system_api`. diff --git a/samples/subsys/input/input.rst b/samples/subsys/input/input.rst index 19e01dc755c..0435d6beb4a 100644 --- a/samples/subsys/input/input.rst +++ b/samples/subsys/input/input.rst @@ -1,10 +1,5 @@ -.. _input-samples: +.. zephyr:code-sample-category:: input + :name: Input + :show-listing: -Input Samples -############# - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`input` subsystem. diff --git a/samples/subsys/ipc/ipc.rst b/samples/subsys/ipc/ipc.rst index c75a201fd3e..8d536c4addd 100644 --- a/samples/subsys/ipc/ipc.rst +++ b/samples/subsys/ipc/ipc.rst @@ -1,10 +1,6 @@ -.. _ipc_samples: +.. zephyr:code-sample-category:: ipc + :name: Inter-Processor Communication (IPC) + :show-listing: + :glob: **/* -IPC Samples -########### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate :ref:`Inter-Processor Communication (IPC) ` features. diff --git a/samples/subsys/llext/llext.rst b/samples/subsys/llext/llext.rst index f9001e2847b..b0eee9d8772 100644 --- a/samples/subsys/llext/llext.rst +++ b/samples/subsys/llext/llext.rst @@ -1,10 +1,5 @@ -.. _llext-samples: +.. zephyr:code-sample-category:: llext + :name: Linkable Loadable Extensions (LLEXT) + :show-listing: -Linkable Loadable Extension Samples -################################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`llext` subsystem. diff --git a/samples/subsys/logging/logging.rst b/samples/subsys/logging/logging.rst index 6b43a116f28..49bbd040aa6 100644 --- a/samples/subsys/logging/logging.rst +++ b/samples/subsys/logging/logging.rst @@ -1,10 +1,5 @@ -.. _logging-samples: +.. zephyr:code-sample-category:: logging + :name: Logging + :show-listing: -Logging Sample -################ - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`logging_api` subsystem. diff --git a/samples/subsys/lorawan/lorawan.rst b/samples/subsys/lorawan/lorawan.rst index ffe86ce523f..0f5aab0bbd0 100644 --- a/samples/subsys/lorawan/lorawan.rst +++ b/samples/subsys/lorawan/lorawan.rst @@ -1,10 +1,5 @@ -.. _lorawan-samples: +.. zephyr:code-sample-category:: lorawan + :name: LoRaWAN + :show-listing: -LoRaWAN Samples -############### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`LoRaWAN ` subsystem. diff --git a/samples/subsys/mgmt/mcumgr/smp_svr/README.rst b/samples/subsys/mgmt/mcumgr/smp_svr/README.rst index a9ddfcbf4a1..8d8830903b9 100644 --- a/samples/subsys/mgmt/mcumgr/smp_svr/README.rst +++ b/samples/subsys/mgmt/mcumgr/smp_svr/README.rst @@ -1,3 +1,5 @@ +:orphan: + .. zephyr:code-sample:: smp-svr :name: SMP server diff --git a/samples/subsys/mgmt/mgmt.rst b/samples/subsys/mgmt/mgmt.rst index a8fa8135aa7..a1112077e45 100644 --- a/samples/subsys/mgmt/mgmt.rst +++ b/samples/subsys/mgmt/mgmt.rst @@ -1,10 +1,5 @@ -.. _mgmt-samples: +.. zephyr:code-sample-category:: mgmt + :name: Management + :show-listing: -Management Samples -################## - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate various device management features. diff --git a/samples/subsys/modbus/modbus.rst b/samples/subsys/modbus/modbus.rst index 133dbd43be7..94719d7a231 100644 --- a/samples/subsys/modbus/modbus.rst +++ b/samples/subsys/modbus/modbus.rst @@ -1,10 +1,5 @@ -.. _modbus-samples: +.. zephyr:code-sample-category:: modbus + :name: Modbus + :show-listing: -Modbus Samples -############## - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`modbus` subsystem. diff --git a/samples/subsys/portability/portability.rst b/samples/subsys/portability/portability.rst index 9034372320f..bf282e94547 100644 --- a/samples/subsys/portability/portability.rst +++ b/samples/subsys/portability/portability.rst @@ -1,12 +1,8 @@ -.. _portability-samples: +.. zephyr:code-sample-category:: portability + :name: Portability + :show-listing: + :glob: **/* -Portability Samples -################### + Samples that demonstrate :ref:`OS abstraction and portability ` features. -.. toctree:: - :maxdepth: 1 - :glob: - - **/* - -See also :ref:`POSIX API Samples `. + See also :zephyr:code-sample-category:`POSIX sample applications`. diff --git a/samples/subsys/profiling/profiling.rst b/samples/subsys/profiling/profiling.rst index a9765517a4b..777bb9ba07a 100644 --- a/samples/subsys/profiling/profiling.rst +++ b/samples/subsys/profiling/profiling.rst @@ -1,10 +1,5 @@ -.. _profiling-samples: +.. zephyr:code-sample-category:: profiling + :name: Profiling + :show-listing: -Profiling subsystem samples -########################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`profiling` subsystem. diff --git a/samples/subsys/sensing/sensing.rst b/samples/subsys/sensing/sensing.rst index 99fdf509c08..bfd39ed399e 100644 --- a/samples/subsys/sensing/sensing.rst +++ b/samples/subsys/sensing/sensing.rst @@ -1,10 +1,5 @@ -.. _sensing-subsystem-samples: +.. zephyr:code-sample-category:: sensing + :name: Sensing + :show-listing: -Sensing Subsystem Samples -######################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`sensing` subsystem. diff --git a/samples/subsys/shell/shell.rst b/samples/subsys/shell/shell.rst index 1cd81f59b0c..b783261a07a 100644 --- a/samples/subsys/shell/shell.rst +++ b/samples/subsys/shell/shell.rst @@ -1,10 +1,5 @@ -.. _shell-samples: +.. zephyr:code-sample-category:: shell + :name: Shell + :show-listing: -Shell System Samples -#################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`shell_api` subsystem. diff --git a/samples/subsys/smf/smf.rst b/samples/subsys/smf/smf.rst index bc48258b99f..772771a6daf 100644 --- a/samples/subsys/smf/smf.rst +++ b/samples/subsys/smf/smf.rst @@ -1,10 +1,5 @@ -.. _smf-samples: +.. zephyr:code-sample-category:: smf + :name: State Machine Framework + :show-listing: -State Machine Framework Samples -############################### - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use the :ref:`State Machine Framework ` subsystem. diff --git a/samples/subsys/subsys.rst b/samples/subsys/subsys.rst index bf58c7dda63..4651375ada8 100644 --- a/samples/subsys/subsys.rst +++ b/samples/subsys/subsys.rst @@ -1,11 +1,5 @@ -.. _subsystem-samples: +.. zephyr:code-sample-category:: subsys + :name: Subsystems + :show-listing: -Various Subsystems Samples -########################## - -.. toctree:: - :titlesonly: - :maxdepth: 2 - :glob: - - */* + These samples demonstrate how to use various subsystems supported by Zephyr. diff --git a/samples/subsys/testsuite/testsuite.rst b/samples/subsys/testsuite/testsuite.rst index 7c84784e9a6..e3438ace124 100644 --- a/samples/subsys/testsuite/testsuite.rst +++ b/samples/subsys/testsuite/testsuite.rst @@ -1,10 +1,4 @@ -.. _testsuite-samples: - -Testsuite samples -################# - -.. toctree:: - :maxdepth: 1 - :glob: - - **/README +.. zephyr:code-sample-category:: testsuite + :name: Test suites + :show-listing: + :glob: **/* diff --git a/samples/subsys/usb/usb.rst b/samples/subsys/usb/usb.rst index 5da80b0e219..a86c7cb3a1f 100644 --- a/samples/subsys/usb/usb.rst +++ b/samples/subsys/usb/usb.rst @@ -1,10 +1,6 @@ -.. _usb-samples: +.. zephyr:code-sample-category:: usb + :name: USB device support + :show-listing: + :glob: **/* -USB device support samples -########################## - -.. toctree:: - :maxdepth: 1 - :glob: - - **/README + Samples that demonstrate :ref:`usb_device_stack`. diff --git a/samples/subsys/usb_c/usbc.rst b/samples/subsys/usb_c/usbc.rst index da0db220b15..8ef11f95118 100644 --- a/samples/subsys/usb_c/usbc.rst +++ b/samples/subsys/usb_c/usbc.rst @@ -1,10 +1,5 @@ -.. _usbc-samples: +.. zephyr:code-sample-category:: usbc + :name: USB-C device support + :show-listing: -USB-C device support samples -############################ - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate the :ref:`usbc_api`. diff --git a/samples/subsys/zbus/zbus.rst b/samples/subsys/zbus/zbus.rst index 052589eed94..41a0619193d 100644 --- a/samples/subsys/zbus/zbus.rst +++ b/samples/subsys/zbus/zbus.rst @@ -1,10 +1,5 @@ -.. _zbus_samples: +.. zephyr:code-sample-category:: zbus + :name: zbus + :show-listing: -zbus Samples -############ - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + These samples demonstrate how to use the :ref:`zbus ` subsystem. diff --git a/samples/sysbuild/sysbuild.rst b/samples/sysbuild/sysbuild.rst index c959e82a3a3..bd1c4be9dca 100644 --- a/samples/sysbuild/sysbuild.rst +++ b/samples/sysbuild/sysbuild.rst @@ -1,10 +1,5 @@ -.. _sysbuild-samples: +.. zephyr:code-sample-category:: sysbuild + :name: Sysbuild + :show-listing: -Sysbuild samples -################ - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate how to use :ref:`sysbuild`. diff --git a/samples/sysbuild/with_mcuboot/README.rst b/samples/sysbuild/with_mcuboot/README.rst index 6ae3b81e6ec..cf8729ab0f8 100644 --- a/samples/sysbuild/with_mcuboot/README.rst +++ b/samples/sysbuild/with_mcuboot/README.rst @@ -1,7 +1,7 @@ -.. _with_mcuboot: +.. zephyr:code-sample:: with_mcuboot + :name: MCUboot with sysbuild -Sample with MCUboot -################### + Build a Zephyr application + MCUboot using sysbuild. Overview ******** diff --git a/samples/tfm_integration/tfm_integration.rst b/samples/tfm_integration/tfm_integration.rst index 02cd3e97855..a445c38cfb2 100644 --- a/samples/tfm_integration/tfm_integration.rst +++ b/samples/tfm_integration/tfm_integration.rst @@ -1,18 +1,12 @@ -.. _tfm_integration-samples: +.. zephyr:code-sample-category:: tfm_integration + :name: TF-M Integration + :show-listing: -TF-M Integration Samples -######################## - -.. toctree:: - :maxdepth: 1 - :glob: - - */* + These TF-M integration examples can be used with a supported Armv8-M board, and demonstrate how + the TF-M APIs can be used with Zephyr. Overview ******** -These TF-M integration examples can be used with a supported Armv8-M board, and -demonstrate how the TF-M APIs can be used with Zephyr. Trusted Firmware Platform Security Architecture (PSA) APIs are used for the secure processing environment (S), with Zephyr running in the non-secure diff --git a/samples/userspace/hello_world_user/README.rst b/samples/userspace/hello_world_user/README.rst index 4f6d83d692b..22ece4becea 100644 --- a/samples/userspace/hello_world_user/README.rst +++ b/samples/userspace/hello_world_user/README.rst @@ -1,7 +1,7 @@ -.. _hello_world_user: +.. zephyr:code-sample:: helloworld_user + :name: Hello World -Hello World -########### + Print a simple "Hello World" from userspace. Overview ******** diff --git a/samples/userspace/index.rst b/samples/userspace/index.rst index 6c455acb9f1..7d387d360d9 100644 --- a/samples/userspace/index.rst +++ b/samples/userspace/index.rst @@ -1,10 +1,5 @@ -.. _userspace-samples: +.. zephyr:code-sample-category:: userspace + :name: Userspace + :show-listing: -Userspace Samples -################# - -.. toctree:: - :maxdepth: 1 - :glob: - - **/* + Samples that demonstrate how to run code in :ref:`usermode_api`. diff --git a/samples/userspace/prod_consumer/README.rst b/samples/userspace/prod_consumer/README.rst index ad6f37e521e..cbe6b72295a 100644 --- a/samples/userspace/prod_consumer/README.rst +++ b/samples/userspace/prod_consumer/README.rst @@ -1,9 +1,7 @@ -.. _userspace_prod_consumer: +.. zephyr:code-sample:: userspace_prod_consumer + :name: Producer/consumer -Producer/consumer -================= - -This is a sample application that exercises some user mode concepts. + Manipulate basic user mode concepts. Overview ******** diff --git a/samples/userspace/shared_mem/README.rst b/samples/userspace/shared_mem/README.rst index 7c9db36f243..33cf81ee0be 100644 --- a/samples/userspace/shared_mem/README.rst +++ b/samples/userspace/shared_mem/README.rst @@ -1,7 +1,7 @@ -.. _userspace_protected_memory: +.. zephyr:code-sample:: userspace_protected_memory + :name: Userspace Protected Memory -Userspace Protected Memory -########################## + Use memory partitioning to protect memory between threads. Overview ******** diff --git a/samples/userspace/syscall_perf/README.rst b/samples/userspace/syscall_perf/README.rst index 2f5c1ed78ee..c0e677597a0 100644 --- a/samples/userspace/syscall_perf/README.rst +++ b/samples/userspace/syscall_perf/README.rst @@ -1,4 +1,7 @@ -.. _syscall_perf: +.. zephyr:code-sample:: syscall_perf + :name: Syscall performance + + Measure performance overhead of a system calls compared to direct function calls. Syscall performances ====================