Skip to content

Commit dde79ec

Browse files
gauteslcarlescufi
authored andcommitted
doc: automate the sample requirement section
Modified most samples and applications so they use the table-from-sample-yaml directive instead of table-from-rows, so that all boards are automatically read from the integration_platforms section of sample.yaml files. Signed-off-by: Gaute Svanes Lunde <[email protected]>
1 parent ab4bc09 commit dde79ec

File tree

141 files changed

+141
-423
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

141 files changed

+141
-423
lines changed

applications/asset_tracker_v2/doc/asset_tracker_v2_description.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,7 @@ Requirements
157157

158158
The application supports the following development kits:
159159

160-
.. table-from-rows:: /includes/sample_board_rows.txt
161-
:header: heading
162-
:rows: thingy91_nrf9160_ns, nrf9160dk_nrf9160_ns
160+
.. table-from-sample-yaml::
163161

164162
.. include:: /includes/spm.txt
165163

applications/connectivity_bridge/README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,7 @@ Requirements
5252

5353
The sample supports the following nRF52840-based device:
5454

55-
.. table-from-rows:: /includes/sample_board_rows.txt
56-
:header: heading
57-
:rows: thingy91_nrf52840
55+
.. table-from-sample-yaml::
5856

5957
The sample also requires a USB host which can communicate with CDC ACM devices, such as a Windows or Linux PC.
6058

applications/machine_learning/README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,7 @@ Requirements
131131

132132
The application supports the following development kits:
133133

134-
.. table-from-rows:: /includes/sample_board_rows.txt
135-
:header: heading
136-
:rows: thingy52_nrf52832, thingy53_nrf5340_cpuapp_and_cpuapp_ns, nrf52840dk_nrf52840, nrf5340dk_nrf5340_cpuapp
134+
.. table-from-sample-yaml::
137135

138136
The available configurations use only built-in sensors or the simulated sensor signal.
139137
There is no need to connect any additional components to the board.

applications/matter_weather_station/README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,7 @@ Requirements
8080

8181
The application supports the following development kits:
8282

83-
.. table-from-rows:: /includes/sample_board_rows.txt
84-
:header: heading
85-
:rows: thingy53_nrf5340_cpuapp
83+
.. table-from-sample-yaml::
8684

8785
To commission the weather station device and control it remotely through a Thread network, you also need a Matter controller device :ref:`configured on PC or smartphone <ug_matter_configuring>` (which requires additional hardware depending on which setup you choose).
8886
The recommended way of getting measurement values is using the mobile Matter controller application that comes with a neat graphical interface, performs measurements automatically and visualizes the data.

applications/serial_lte_modem/doc/slm_description.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,7 @@ Requirements
2323

2424
The application supports the following development kits:
2525

26-
.. table-from-rows:: /includes/sample_board_rows.txt
27-
:header: heading
28-
:rows: nrf9160dk_nrf9160_ns, thingy91_nrf9160_ns
26+
.. table-from-sample-yaml::
2927

3028
.. include:: /includes/spm.txt
3129

applications/zigbee_weather_station/README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,7 @@ Requirements
8888

8989
The application supports the following development kits:
9090

91-
.. table-from-rows:: /includes/sample_board_rows.txt
92-
:header: heading
93-
:rows: thingy53_nrf5340_cpuapp
91+
.. table-from-sample-yaml::
9492

9593
To commission the Zigbee weather station device and control it remotely through a Zigbee network, you also need to progam a Zigbee network coordinator on a separate compatible development kit.
9694
The Zigbee network coordinator forms the network that the weather station node will join and onto which it will share its measurement data.

samples/app_event_manager/README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,7 @@ Requirements
3939

4040
The sample supports the following development kits:
4141

42-
.. table-from-rows:: /includes/sample_board_rows.txt
43-
:header: heading
44-
:rows: nrf9160dk_nrf9160_ns, nrf52dk_nrf52832, nrf52840dk_nrf52840, nrf21540dk_nrf52840
42+
.. table-from-sample-yaml::
4543

4644
Configuration
4745
*************

samples/app_event_manager_profiler_tracer/README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ Requirements
1414

1515
The sample supports the following development kits:
1616

17-
.. table-from-rows:: /includes/sample_board_rows.txt
18-
:header: heading
19-
:rows: nrf9160dk_nrf9160_ns, nrf52dk_nrf52832, nrf52840dk_nrf52840, nrf21540dk_nrf52840
17+
.. table-from-sample-yaml::
2018

2119
Overview
2220
********

samples/bluetooth/alexa_gadget/README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,7 @@ Requirements
6565

6666
The sample supports the following development kits:
6767

68-
.. table-from-rows:: /includes/sample_board_rows.txt
69-
:header: heading
70-
:rows: nrf52840dk_nrf52840, nrf52dk_nrf52832, nrf52dk_nrf52810
68+
.. table-from-sample-yaml::
7169

7270
The sample also has the following requirements:
7371

samples/bluetooth/central_and_peripheral_hr/README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ Requirements
2929

3030
The sample supports the following development kits:
3131

32-
.. table-from-rows:: /includes/sample_board_rows.txt
33-
:header: heading
34-
:rows: nrf5340dk_nrf5340_cpuapp_and_cpuapp_ns, nrf52840dk_nrf52840, nrf52dk_nrf52832, nrf52833dk_nrf52833, nrf52833dk_nrf52820, nrf21540dk_nrf52840
32+
.. table-from-sample-yaml::
3533

3634
To test just the Bluetooth® LE Central Role operation, you need one of the following setups:
3735

0 commit comments

Comments
 (0)