Browse Source

boards: ti: adopt new zephyr:board directive and role

This updates the documentation of all the Texas Instruments boards to
use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
pull/80294/head
Benjamin Cabé 9 months ago committed by Carles Cufí
parent
commit
841f8a6a62
  1. 12
      boards/ti/cc1352p1_launchxl/doc/index.rst
  2. 11
      boards/ti/cc1352p7_launchpad/doc/index.rst
  3. 11
      boards/ti/cc1352r1_launchxl/doc/index.rst
  4. 11
      boards/ti/cc1352r_sensortag/doc/index.rst
  5. 11
      boards/ti/cc26x2r1_launchxl/doc/index.rst
  6. 5
      boards/ti/cc3220sf_launchxl/doc/index.rst
  7. 5
      boards/ti/cc3235sf_launchxl/doc/index.rst
  8. 9
      boards/ti/msp_exp432p401r_launchxl/doc/index.rst
  9. 11
      boards/ti/sk_am62/doc/index.rst
  10. 2
      samples/net/mqtt_publisher/README.rst
  11. 2
      samples/net/sockets/echo/README.rst

12
boards/ti/cc1352p1_launchxl/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _cc1352p1_launchxl:
CC1352P1 LaunchXL
#################
.. zephyr:board:: cc1352p1_launchxl
Overview
********
@ -11,13 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC1352P wireless MCU. @@ -11,13 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC1352P wireless MCU.
See the `TI CC1352P LaunchPad Product Page`_ for details.
.. figure:: img/cc1352p1_launchxl.jpg
:width: 400px
:align: center
:alt: TI CC1352P1 LaunchPad
Texas Instruments CC1352P1 LaunchPad |trade|
Hardware
********

11
boards/ti/cc1352p7_launchpad/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _cc1352p7_lp:
CC1352P7 LaunchPad
##################
.. zephyr:board:: cc1352p7_lp
Overview
********
@ -11,12 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC1352P7 wireless MCU. @@ -11,12 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC1352P7 wireless MCU.
See the `TI CC1352P7 LaunchPad Product Page`_ for details.
.. figure:: img/lp-cc1352p7-top.jpg
:width: 400px
:align: center
:alt: TI CC1352P7 LaunchPad
Texas Instruments CC1352P7 LaunchPad |trade|
Hardware
********

11
boards/ti/cc1352r1_launchxl/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _cc1352r1_launchxl:
CC1352R1 LaunchXL
#################
.. zephyr:board:: cc1352r1_launchxl
Overview
********
@ -11,12 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC1352R wireless MCU. @@ -11,12 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC1352R wireless MCU.
See the `TI CC1352R LaunchPad Product Page`_ for details.
.. figure:: img/cc1352r1_launchxl.jpg
:align: center
:alt: TI CC1352R LaunchPad
Texas Instruments CC1352R LaunchPad |trade|
Hardware
********

11
boards/ti/cc1352r_sensortag/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _cc1352r_sensortag:
CC1352R SensorTag
#################
.. zephyr:board:: cc1352r_sensortag
Overview
********
@ -11,12 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC1352R wireless MCU. @@ -11,12 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC1352R wireless MCU.
See the `TI CC1352R SensorTag Product Page`_ for details.
.. figure:: img/cc1352r_sensortag.jpg
:align: center
:alt: TI CC1352R SensorTag
Texas Instruments CC1352R SensorTag |trade|
Hardware
********

11
boards/ti/cc26x2r1_launchxl/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _cc26x2r1_launchxl:
CC26x2R1 LaunchXL
#################
.. zephyr:board:: cc26x2r1_launchxl
Overview
********
@ -11,12 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC2652R wireless MCU. @@ -11,12 +8,6 @@ development kit for the SimpleLink |trade| multi-Standard CC2652R wireless MCU.
See the `TI CC26x2R LaunchPad Product Page`_ for details.
.. figure:: img/cc26x2r1_launchxl.jpg
:align: center
:alt: TI CC26x2R LaunchPad
Texas Instruments CC26x2R LaunchPad |trade|
Hardware
********

5
boards/ti/cc3220sf_launchxl/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _cc3220sf_launchxl:
CC3220SF LaunchXL
#################
.. zephyr:board:: cc3220sf_launchxl
Overview
********

5
boards/ti/cc3235sf_launchxl/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _cc3235sf_launchxl:
CC3235SF LaunchXL
#################
.. zephyr:board:: cc3235sf_launchxl
Overview
********

9
boards/ti/msp_exp432p401r_launchxl/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _msp_exp432p401r_launchxl:
MSP-EXP432P401R LaunchXL
########################
.. zephyr:board:: msp_exp432p401r_launchxl
Overview
********
@ -11,10 +8,6 @@ module for the SimpleLink MSP432P401R microcontroller. It contains everything ne @@ -11,10 +8,6 @@ module for the SimpleLink MSP432P401R microcontroller. It contains everything ne
developing on the SimpleLink MSP432 low-power + performance ARM |reg| 32-bit Cortex |reg|-M4F
microcontroller (MCU).
.. figure:: img/msp_exp432p401r_launchxl.jpg
:align: center
:alt: MSP-EXP432P401R LaunchXL development board
Features:
=========

11
boards/ti/sk_am62/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _sk_am62:
SK-AM62 M4F Core
################
.. zephyr:board:: sk_am62
Overview
********
@ -17,12 +14,6 @@ The board configuration also enables support for the semihosting debugging conso @@ -17,12 +14,6 @@ The board configuration also enables support for the semihosting debugging conso
See the `TI AM62X Product Page`_ for details.
.. figure:: img/sk_am62_angled.webp
:align: center
:alt: TI SK-AM62 EVM
Texas Instruments SK-AM62 EVM
Hardware
********
The SK-AM62 EVM features the AM62x SoC, which is composed of a quad Cortex-A53

2
samples/net/mqtt_publisher/README.rst

@ -217,7 +217,7 @@ In addition, TLS_SNI_HOSTNAME in main.c should be defined to match the @@ -217,7 +217,7 @@ In addition, TLS_SNI_HOSTNAME in main.c should be defined to match the
Common Name (CN) in the certificate file in order for the TLS domain
name verification to succeed.
See the note on Provisioning and Fast Connect in :ref:`cc3220sf_launchxl`.
See the note on Provisioning and Fast Connect in :zephyr:board:`cc3220sf_launchxl`.
The Secure Socket Offload section has information on programming the
certificate to flash.

2
samples/net/sockets/echo/README.rst

@ -76,7 +76,7 @@ version. @@ -76,7 +76,7 @@ version.
Running on cc3220sf_launchxl
============================
See the note on Provisioning and Fast Connect in :ref:`cc3220sf_launchxl`.
See the note on Provisioning and Fast Connect in :zephyr:board:`cc3220sf_launchxl`.
After having connected to an Access Point using the sample Wi-Fi shell,
the IP address will be printed to the console upon running this echo

Loading…
Cancel
Save