michaelh/zephyr
1
0
Fork 0
Code Releases Activity

samples: doc: fix dead links

Browse source 
Fixed deadlinks reported by Sphinx linkchecker

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-06-06 19:04:36 +02:00 • committed by Anas Nashif
commit 21f473aaec
9 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
samples/bluetooth/hci_uart/README.rst
View file

@ -147,7 +147,7 @@ Check the :ref:`bluetooth_direction_finding_connectionless_rx` and the :ref:`blu
Using a USB CDC ACM UART Using a USB CDC ACM UART
======================== ========================
The sample can be configured to use a USB UART instead. See :zephyr_file:`samples/bluetooth/hci_uart/nrf52840dongle_nrf52840.conf` and :zephyr_file:`samples/bluetooth/hci_uart/nrf52840dongle_nrf52840.overlay`. The sample can be configured to use a USB UART instead. See :zephyr_file:`samples/bluetooth/hci_uart/boards/nrf52840dongle_nrf52840.conf` and :zephyr_file:`samples/bluetooth/hci_uart/boards/nrf52840dongle_nrf52840.overlay`.
Using the controller with the Zephyr host Using the controller with the Zephyr host
========================================= =========================================

2
samples/bluetooth/unicast_audio_client/README.rst
View file

@ -19,6 +19,6 @@ Requirements
Building and Running Building and Running
******************** ********************
This sample can be found under This sample can be found under
:zephyr_file:`samples/bluetooth/audio_unicast_client` in the Zephyr tree. :zephyr_file:`samples/bluetooth/unicast_audio_client` in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details. See :ref:`bluetooth samples section <bluetooth-samples>` for details.

2
samples/boards/qomu/README.rst
View file

@ -9,7 +9,7 @@ usbserial driver.
Requirements Requirements
************ ************
* Zephyr RTOS with printk enabled * Zephyr RTOS with printk enabled
* `QuickLogic Qomu board <https://github.com/QuickLogic-Corp/qomu-feather-dev-board>`_ * `QuickLogic Qomu board <https://www.quicklogic.com/products/eos-s3/quickfeather-development-kit/>`_
Building Building
******** ********

2
samples/drivers/auxdisplay/README.rst
View file

@ -15,7 +15,7 @@ Building and Running
Note that this sample requires a board with an auxiliary display setup. A Note that this sample requires a board with an auxiliary display setup. A
sample overlay is provided for the `nucleo_f746zg` board fly-wired to a Hitachi sample overlay is provided for the `nucleo_f746zg` board fly-wired to a Hitachi
HD44780-compatible 20 character by 4 line display. See the overlay file HD44780-compatible 20 character by 4 line display. See the overlay file
:zephyr_file:`samples/drivers/auxdisplayboards/nucleo_f746zg.overlay` for :zephyr_file:`samples/drivers/auxdisplay/boards/nucleo_f746zg.overlay` for
wiring configuration. wiring configuration.
.. zephyr-app-commands:: .. zephyr-app-commands::

4
samples/modules/canopennode/README.rst
View file

@ -433,13 +433,13 @@ generation.
A popular choice is the EDS editor from the `libedssharp`_ A popular choice is the EDS editor from the `libedssharp`_
project. With that, the project. With that, the
:zephyr_file:`samples/modules/canopennode/objdict/objdicts.xml` :zephyr_file:`samples/modules/canopennode/objdict/objdict.xml`
project file can be opened and modified, and new implementation files project file can be opened and modified, and new implementation files
(:zephyr_file:`samples/modules/canopennode/objdict/CO_OD.h` and (:zephyr_file:`samples/modules/canopennode/objdict/CO_OD.h` and
:zephyr_file:`samples/modules/canopennode/objdict/CO_OD.c`) can be :zephyr_file:`samples/modules/canopennode/objdict/CO_OD.c`) can be
generated. The EDS editor can also export an updated Electronic Data generated. The EDS editor can also export an updated Electronic Data
Sheet (EDS) file Sheet (EDS) file
(:zephyr_file:`samples/modules/canopennode/objdict/objdicts.eds`). (:zephyr_file:`samples/modules/canopennode/objdict/objdict.eds`).
.. _CANopenNode: .. _CANopenNode:
https://github.com/CANopenNode/CANopenNode https://github.com/CANopenNode/CANopenNode

2
samples/net/cloud/aws_iot_mqtt/README.rst
View file

@ -36,7 +36,7 @@ the certificate and private key in order to embed them in the application.
Register a *thing* in AWS IoT Core and download the certificate and private key. Register a *thing* in AWS IoT Core and download the certificate and private key.
Copy these files to the :zephyr_file:`samples/net/cloud/aws_iot_mqtt/src/creds` Copy these files to the :zephyr_file:`samples/net/cloud/aws_iot_mqtt/src/creds`
directory. Run the :zephyr_file:`samples/net/cloud/aws_iot_mqtt/src/creds/convert_certs.py` directory. Run the :zephyr_file:`samples/net/cloud/aws_iot_mqtt/src/creds/convert_keys.py`
script, which will generate files ``ca.c``, ``cert.c`` and ``key.c``. script, which will generate files ``ca.c``, ``cert.c`` and ``key.c``.
To configure the sample, set the following Kconfig options based on your AWS IoT To configure the sample, set the following Kconfig options based on your AWS IoT

2
samples/sensor/wsen_itds/README.rst
View file

@ -21,7 +21,7 @@ Requirements
References References
********** **********
- WSEN-ITDS: https://www.we-online.com/catalog/manual/2533020201601_WSEN-ITDS%202533020201601%20Manual_rev1.pdf - WSEN-ITDS: https://www.we-online.com/components/products/manual/2533020201601_WSEN-ITDS%202533020201601%20Manual_rev2.3.pdf
Building and Running Building and Running
******************** ********************

2
samples/shields/x_nucleo_iks01a2/standard/README.rst
View file

@ -22,7 +22,7 @@ configured for the I2C Arduino connector in the devicetree. See for
example the :ref:`nucleo_f401re_board` board source code: example the :ref:`nucleo_f401re_board` board source code:
- :zephyr_file:`boards/arm/nucleo_f401re/nucleo_f401re.dts` - :zephyr_file:`boards/arm/nucleo_f401re/nucleo_f401re.dts`
- :zephyr_file:`boards/arm/nucleo_f401re/arduino_r3_connector.dts` - :zephyr_file:`boards/arm/nucleo_f401re/arduino_r3_connector.dtsi`
Please note that this sample can't be used with boards already supporting Please note that this sample can't be used with boards already supporting
one of the sensors available on the shield (such as disco_l475_iot1) as zephyr one of the sensors available on the shield (such as disco_l475_iot1) as zephyr

2
samples/subsys/tracing/README.rst
View file

@ -71,7 +71,7 @@ After the serial console has stable output like this:
threadB: Hello World! threadB: Hello World!
Connect the board's USB port to the host device and Connect the board's USB port to the host device and
run the :zephyr_file:`trace_capture_usb.py` script on the host: run the :zephyr_file:`scripts/tracing/trace_capture_usb.py` script on the host:
.. code-block:: console .. code-block:: console