michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: sphinx-lint: fix bad usage of "default role"

Browse source 
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é <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-09-10 19:51:57 +02:00 • committed by Mahesh Mahadevan
commit df294e34e1
127 changed files with 304 additions and 285 deletions
Download patch file Download diff file Expand all files Collapse all files

3
boards/sparkfun/micromod/doc/index.rst
View file

@ -139,7 +139,7 @@ applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
The flashing tool will depend on the carrier used along with the board.
In the case of `Sparkfun asset tracking carrier`, it is possible to use
In the case of `Sparkfun asset tracking carrier`_, it is possible to use
the SWD interface along with a J-Link.
Here is an example for the :ref:`hello_world` application.
@ -199,6 +199,7 @@ References
.. target-notes::
.. _Micromod specification website: https://www.sparkfun.com/micromod
.. _Sparkfun asset tracking carrier: https://www.sparkfun.com/products/17272
.. _Micromod nRF52840 guide: https://learn.sparkfun.com/tutorials/micromod-nrf52840-processor-hookup-guide
.. _J-Link Software and documentation pack: https://www.segger.com/jlink-software.html
.. _nRF52840 Product Specification: http://infocenter.nordicsemi.com/pdf/nRF52840_PS_v1.0.pdf

4
boards/sparkfun/pro_micro_rp2040/doc/index.rst
View file

@ -119,8 +119,8 @@ The Pro Micro board does make the SWD pins available on pads on the
underside of the board. You can solder to these pins, and use a JTag
debugger. You can also flash the SparkFun ProMicro RP2040 with a UF2 file.
By default, building an app for this board will generate a
`build/zephyr/zephyr.uf2` file. If the Pro Micro RP2040 is powered on with
the `BOOTSEL` button pressed, it will appear on the host as a mass storage
:file:`build/zephyr/zephyr.uf2` file. If the Pro Micro RP2040 is powered on with
the ``BOOTSEL`` button pressed, it will appear on the host as a mass storage
device. The UF2 file should be copied to the device, which will
flash the Pro Micro RP2040.

2
boards/sparkfun/thing_plus/doc/index.rst
View file

@ -92,7 +92,7 @@ In most cases you'll want to use the ``ns`` target with any of the Zephyr
or Nordic based examples.
Some of the examples do not use secure mode, so they do not required the ``ns`` suffix.
A great example of this is the `hello_world` below.
A great example of this is the :ref:`hello_world` below.
Flashing
========