Skip to content

Commit df294e3

Browse files
kartbenmmahadevan108
authored andcommitted
doc: sphinx-lint: fix bad usage of "default role"
Fixes bad usage of single backticks in lieu of double backticks for rendering inline literals, or simple '*' for italics. When appropriate, a better construct than double backticks has been selected (ex. :file:, :kconfig:option:, :c:func:, ...), or proper :ref: have been used if the original intention was to have a link. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 49bd808 commit df294e3

File tree

127 files changed

+304
-285
lines changed

Some content is hidden

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

127 files changed

+304
-285
lines changed

boards/adafruit/feather_nrf52840/doc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,8 @@ but does not support debugging the device.
181181
#. If using UF2, connect the board to your host computer using USB.
182182

183183
#. Tap the reset button twice quickly to enter bootloader mode.
184-
A mass storage device named `FTHR840BOOT` for (Express) or
185-
`FTHRSNSBOOT` (Sense) should appear on the host. Ensure this is
184+
A mass storage device named ``FTHR840BOOT`` for (Express) or
185+
``FTHRSNSBOOT`` (Sense) should appear on the host. Ensure this is
186186
mounted.
187187

188188
#. Flash the image.

boards/adafruit/kb2040/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Using UF2
117117

118118
Since it doesn't expose the SWD pins, you must flash the Adafruit KB2040 with
119119
a UF2 file. By default, building an app for this board will generate a
120-
`build/zephyr/zephyr.uf2` file. If the KB2040 is powered on with the `BOOTSEL`
120+
:file:`build/zephyr/zephyr.uf2` file. If the KB2040 is powered on with the ``BOOTSEL``
121121
button pressed, it will appear on the host as a mass storage device. The
122122
UF2 file should be drag-and-dropped to the device, which will flash the KB2040.
123123

boards/adafruit/qt_py_rp2040/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Using UF2
116116

117117
Since it doesn't expose the SWD pins, you must flash the Adafruit QT Py RP2040 with
118118
a UF2 file. By default, building an app for this board will generate a
119-
`build/zephyr/zephyr.uf2` file. If the QT Py RP2040 is powered on with the `BOOTSEL`
119+
:file:`build/zephyr/zephyr.uf2` file. If the QT Py RP2040 is powered on with the ``BOOTSEL``
120120
button pressed, it will appear on the host as a mass storage device. The
121121
UF2 file should be drag-and-dropped to the device, which will flash the QT Py RP2040.
122122

boards/ambiq/apollo3_evb/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Build the Zephyr kernel and application, then flash it to the device:
6969
:goals: flash
7070

7171
.. note::
72-
`west flash` requires `SEGGER J-Link software`_ and `pylink`_ Python module
72+
``west flash`` requires `SEGGER J-Link software`_ and `pylink`_ Python module
7373
to be installed on you host computer.
7474

7575
Open a serial terminal (minicom, putty, etc.) with the following settings:

boards/ambiq/apollo3p_evb/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Build the Zephyr kernel and application, then flash it to the device:
6969
:goals: flash
7070

7171
.. note::
72-
`west flash` requires `SEGGER J-Link software`_ and `pylink`_ Python module
72+
``west flash`` requires `SEGGER J-Link software`_ and `pylink`_ Python module
7373
to be installed on you host computer.
7474

7575
Open a serial terminal (minicom, putty, etc.) with the following settings:

boards/ambiq/apollo4p_blue_kxr_evb/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Build the Zephyr kernel and application, then flash it to the device:
7777
:goals: flash
7878

7979
.. note::
80-
`west flash` requires `SEGGER J-Link software`_ and `pylink`_ Python module
80+
``west flash`` requires `SEGGER J-Link software`_ and `pylink`_ Python module
8181
to be installed on you host computer.
8282

8383
Open a serial terminal (minicom, putty, etc.) with the following settings:

boards/ambiq/apollo4p_evb/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Build the Zephyr kernel and application, then flash it to the device:
7272
:goals: flash
7373

7474
.. note::
75-
`west flash` requires `SEGGER J-Link software`_ and `pylink`_ Python module
75+
``west flash`` requires `SEGGER J-Link software`_ and `pylink`_ Python module
7676
to be installed on you host computer.
7777

7878
Open a serial terminal (minicom, putty, etc.) with the following settings:

boards/arduino/nano_33_ble/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ That license ties to Arduino Nano 33 BLE hardware serial number,
160160
it also works with the ZephyrRTOS.
161161

162162
Follow the instruction of the tutorial for Arduino
163-
`Lauterbach TRACE32 GDB Front-End Debugger for Nano 33 BLE`
163+
`Lauterbach TRACE32 GDB Front-End Debugger for Nano 33 BLE`_
164164
to install the TRACE32.
165165

166166
After installing the TRACE32, You should set the environmental variable ``T32_DIR``.

boards/arm/fvp_base_revc_2xaemv8a/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Checkout and Build the TF-A:
9999
cd trusted-firmware-a/
100100
make PLAT=fvp PRELOADED_BL33_BASE="0x88000000" all fip
101101
102-
then export the ``ARMFVP_BL1_FILE` and ``ARMFVP_FIP_FILE`` environment variables:
102+
then export the :envvar:`ARMFVP_BL1_FILE` and :envvar:`ARMFVP_FIP_FILE` environment variables:
103103

104104
.. code-block:: console
105105

boards/circuitdojo/feather/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ or Nordic based examples.
100100
Trusted Firmware-M (TF-M) and building the ``ns`` target is not supported for this board.
101101

102102
Some of the examples do not use secure mode, so they do not require the
103-
``ns`` suffix. A great example of this is the `hello_world` below.
103+
``ns`` suffix. A great example of this is the ``hello_world`` below.
104104

105105
Flashing
106106
========

0 commit comments

Comments
 (0)