Skip to content

Commit fb7a74e

Browse files
kartbencfriedt
authored andcommitted
doc: boards: nxp: common documentation snippets should not be in toctree
Ensure that common documentation snippets meant to be "literalinclude"d in other pages are not treated as regular rst files and de facto excluded from the documentation global toctree. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
1 parent 1307512 commit fb7a74e

File tree

85 files changed

+111
-218
lines changed

Some content is hidden

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

85 files changed

+111
-218
lines changed

boards/nxp/common/board-footer.rst renamed to boards/nxp/common/board-footer.rst.inc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
:orphan:
2-
3-
.. nxp-board-footer
4-
51
Support Resources for Zephyr
62
============================
73
- `NXP Zephyr Downstream Software Development Kit`_

boards/nxp/common/opensda-debug.rst renamed to boards/nxp/common/opensda-debug.rst.inc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
:orphan:
2-
3-
.. nxp-opensda-probes
4-
51
A debug probe is used for both flashing and debugging the board. This board has
62
an :ref:`opensda-onboard-debug-probe`. The default firmware present on this
73
probe is the :ref:`opensda-daplink-onboard-debug-probe`.

boards/nxp/common/rt1xxx-lpclink2-debug.rst renamed to boards/nxp/common/rt1xxx-lpclink2-debug.rst.inc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
:orphan:
2-
3-
.. rt1xxx-lpclink2-probes
4-
51
A debug probe is used for both flashing and debugging the board. This board has
62
an :ref:`lpc-link2-onboard-debug-probe`. The default firmware present on this
73
probe is the :ref:`lpclink2-daplink-onboard-debug-probe`.

boards/nxp/common/segger-ecc-systemview.rst renamed to boards/nxp/common/segger-ecc-systemview.rst.inc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
:orphan:
2-
3-
.. segger-ecc-systemview
4-
51
Using Segger SystemView and RTT
62
-------------------------------
73

boards/nxp/frdm_imx91/doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,5 +118,4 @@ display the following console output:
118118
thread_a: Hello World from cpu 0 on frdm_imx91!
119119
thread_b: Hello World from cpu 0 on frdm_imx91!
120120
121-
.. include:: ../../common/board-footer.rst
122-
:start-after: nxp-board-footer
121+
.. include:: ../../common/board-footer.rst.inc

boards/nxp/frdm_imx93/doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,5 +160,4 @@ kernel reboot command in shell command line:
160160
161161
uart:~$ kernel reboot cold
162162
163-
.. include:: ../../common/board-footer.rst
164-
:start-after: nxp-board-footer
163+
.. include:: ../../common/board-footer.rst.inc

boards/nxp/frdm_k22f/doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,8 +239,7 @@ should see the following message in the terminal:
239239
***** Booting Zephyr OS v2.0.0 *****
240240
Hello World! frdm_k22f
241241
242-
.. include:: ../../common/board-footer.rst
243-
:start-after: nxp-board-footer
242+
.. include:: ../../common/board-footer.rst.inc
244243

245244
.. _FRDM-K22F Website:
246245
https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/freedom-development-boards/mcu-boards/nxp-freedom-development-platform-for-kinetis-k22-mcus:FRDM-K22F

boards/nxp/frdm_k32l2b3/doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,7 @@ should see the following message in the terminal:
165165
*** Booting Zephyr OS build v4.1.0-7032-g3198db1b1229 ***
166166
Hello World! frdm_k32l2b3/k32l2b31a
167167
168-
.. include:: ../../common/board-footer.rst
169-
:start-after: nxp-board-footer
168+
.. include:: ../../common/board-footer.rst.inc
170169

171170
.. _KL32-L2 Website:
172171
https://www.nxp.com/products/K32-L2

boards/nxp/frdm_k64f/doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,7 @@ of pyocd commands:
307307
Resetting target
308308
>>> quit
309309
310-
.. include:: ../../common/board-footer.rst
311-
:start-after: nxp-board-footer
310+
.. include:: ../../common/board-footer.rst.inc
312311

313312
.. _FRDM-K64F Website:
314313
https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/freedom-development-boards/mcu-boards/freedom-development-platform-for-kinetis-k64-k63-and-k24-mcus:FRDM-K64F

boards/nxp/frdm_k82f/doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,7 @@ should see the following message in the terminal:
178178
***** Booting Zephyr OS v1.14.0-xxx-gxxxxxxxxxxxx *****
179179
Hello World! frdm_k82f
180180
181-
.. include:: ../../common/board-footer.rst
182-
:start-after: nxp-board-footer
181+
.. include:: ../../common/board-footer.rst.inc
183182

184183
.. _FRDM-K82F Website:
185184
https://www.nxp.com/design/development-boards/freedom-development-boards/mcu-boards/freedom-development-platform-for-kinetis-k82-k81-and-k80-mcus:FRDM-K82F

0 commit comments

Comments
 (0)