From 21f473aaecf087e357df19c78ae2bd60aed345dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Tue, 6 Jun 2023 19:04:36 +0200 Subject: [PATCH] samples: doc: fix dead links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixed deadlinks reported by Sphinx linkchecker Signed-off-by: Benjamin Cabé --- samples/bluetooth/hci_uart/README.rst | 2 +- samples/bluetooth/unicast_audio_client/README.rst | 2 +- samples/boards/qomu/README.rst | 2 +- samples/drivers/auxdisplay/README.rst | 2 +- samples/modules/canopennode/README.rst | 4 ++-- samples/net/cloud/aws_iot_mqtt/README.rst | 2 +- samples/sensor/wsen_itds/README.rst | 2 +- samples/shields/x_nucleo_iks01a2/standard/README.rst | 2 +- samples/subsys/tracing/README.rst | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/samples/bluetooth/hci_uart/README.rst b/samples/bluetooth/hci_uart/README.rst index 21e46970eb6..83004cd544f 100644 --- a/samples/bluetooth/hci_uart/README.rst +++ b/samples/bluetooth/hci_uart/README.rst @@ -147,7 +147,7 @@ Check the :ref:`bluetooth_direction_finding_connectionless_rx` and the :ref:`blu 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 ========================================= diff --git a/samples/bluetooth/unicast_audio_client/README.rst b/samples/bluetooth/unicast_audio_client/README.rst index 1fb776392a7..b9acf06d023 100644 --- a/samples/bluetooth/unicast_audio_client/README.rst +++ b/samples/bluetooth/unicast_audio_client/README.rst @@ -19,6 +19,6 @@ Requirements Building and Running ******************** 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 ` for details. diff --git a/samples/boards/qomu/README.rst b/samples/boards/qomu/README.rst index b5d1f20a753..d71ab064e0b 100644 --- a/samples/boards/qomu/README.rst +++ b/samples/boards/qomu/README.rst @@ -9,7 +9,7 @@ usbserial driver. Requirements ************ * Zephyr RTOS with printk enabled -* `QuickLogic Qomu board `_ +* `QuickLogic Qomu board `_ Building ******** diff --git a/samples/drivers/auxdisplay/README.rst b/samples/drivers/auxdisplay/README.rst index 2119a7d8a9a..1bbe5750d6a 100644 --- a/samples/drivers/auxdisplay/README.rst +++ b/samples/drivers/auxdisplay/README.rst @@ -15,7 +15,7 @@ Building and Running 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 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. .. zephyr-app-commands:: diff --git a/samples/modules/canopennode/README.rst b/samples/modules/canopennode/README.rst index fd0e79934f8..ae6f135ae30 100644 --- a/samples/modules/canopennode/README.rst +++ b/samples/modules/canopennode/README.rst @@ -433,13 +433,13 @@ generation. A popular choice is the EDS editor from the `libedssharp`_ 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 (:zephyr_file:`samples/modules/canopennode/objdict/CO_OD.h` and :zephyr_file:`samples/modules/canopennode/objdict/CO_OD.c`) can be generated. The EDS editor can also export an updated Electronic Data Sheet (EDS) file -(:zephyr_file:`samples/modules/canopennode/objdict/objdicts.eds`). +(:zephyr_file:`samples/modules/canopennode/objdict/objdict.eds`). .. _CANopenNode: https://github.com/CANopenNode/CANopenNode diff --git a/samples/net/cloud/aws_iot_mqtt/README.rst b/samples/net/cloud/aws_iot_mqtt/README.rst index 5c98c6aacee..0f0d08234d2 100644 --- a/samples/net/cloud/aws_iot_mqtt/README.rst +++ b/samples/net/cloud/aws_iot_mqtt/README.rst @@ -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. 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``. To configure the sample, set the following Kconfig options based on your AWS IoT diff --git a/samples/sensor/wsen_itds/README.rst b/samples/sensor/wsen_itds/README.rst index b7dd98b587d..bddb4feaf5a 100644 --- a/samples/sensor/wsen_itds/README.rst +++ b/samples/sensor/wsen_itds/README.rst @@ -21,7 +21,7 @@ Requirements 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 ******************** diff --git a/samples/shields/x_nucleo_iks01a2/standard/README.rst b/samples/shields/x_nucleo_iks01a2/standard/README.rst index e7577084203..a31a7a75b4d 100644 --- a/samples/shields/x_nucleo_iks01a2/standard/README.rst +++ b/samples/shields/x_nucleo_iks01a2/standard/README.rst @@ -22,7 +22,7 @@ configured for the I2C Arduino connector in the devicetree. See for example the :ref:`nucleo_f401re_board` board source code: - :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 one of the sensors available on the shield (such as disco_l475_iot1) as zephyr diff --git a/samples/subsys/tracing/README.rst b/samples/subsys/tracing/README.rst index adaa62c2086..a8be7e0445f 100644 --- a/samples/subsys/tracing/README.rst +++ b/samples/subsys/tracing/README.rst @@ -71,7 +71,7 @@ After the serial console has stable output like this: threadB: Hello World! 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