Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: samples: Introduce code sample categories #77400

Merged
merged 4 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion boards/adafruit/feather_m0_basic_proto/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/feather_m0_lora/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/grand_central_m4_express/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/itsybitsy_m4_express/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/trinket_m0/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/mkrzero/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/nano_33_iot/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/zero/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32_devkitc_wroom/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32_devkitc_wrover/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32s3_devkitc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`_.
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif/esp32s3_devkitm/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`_.
Expand Down
2 changes: 1 addition & 1 deletion boards/openisa/rv32m1_vega/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion boards/others/serpente/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/seeed/seeeduino_xiao/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/seeed/wio_terminal/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion boards/shields/npm1300_ek/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/shields/npm6001_ek/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions boards/snps/hsdk/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -387,9 +387,9 @@ Set up Zephyr Software
Building Sample Applications
==============================

You can try many of the :ref:`sample applications and demos
<samples-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 <samples>`.
We'll use :zephyr:code-sample:`hello_world`, found in :zephyr_file:`samples/hello_world` as an
example.

Configuring
-----------
Expand Down
5 changes: 2 additions & 3 deletions boards/snps/hsdk4xd/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -384,9 +384,8 @@ Set up Zephyr Software
Building Sample Applications
==============================

You can try many of the :ref:`sample applications and demos
<samples-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 <samples>`.
We'll use :zephyr:code-sample:`hello_world`, found in :zephyr_file:`samples/hello_world` as an example.

Configuring
-----------
Expand Down
2 changes: 1 addition & 1 deletion boards/waveshare/esp32s3_touch_lcd_1_28/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`_.
Expand Down
Loading
Loading