From 24e0d91cd02bf22f61164a7e1874a5f0cd18ee94 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Mon, 6 Mar 2023 10:55:30 +0800 Subject: [PATCH] docs: fix broken links --- .../bt/host/bluedroid/api/include/api/esp_gap_ble_api.h | 2 +- docs/conf_common.py | 4 ++++ docs/en/api-reference/peripherals/gpio/esp32.inc | 2 +- docs/en/api-reference/peripherals/gpio/esp32c3.inc | 2 +- docs/en/api-reference/peripherals/gpio/esp32c6.inc | 2 +- docs/en/api-reference/peripherals/gpio/esp32h2.inc | 2 +- docs/en/api-reference/peripherals/gpio/esp32s2.inc | 2 +- docs/en/api-reference/peripherals/gpio/esp32s3.inc | 2 +- docs/zh_CN/api-guides/app_trace.rst | 2 +- docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst | 4 ++-- docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v3.rst | 2 +- docs/zh_CN/hw-reference/esp32/user-guide-devkits-r-v1.1.rst | 2 +- 12 files changed, 16 insertions(+), 12 deletions(-) diff --git a/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h b/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h index 17e21b6373..d569cc5024 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h @@ -1471,7 +1471,7 @@ esp_err_t esp_ble_gap_config_local_privacy (bool privacy_enable); * * * @param[in] icon - External appearance value, these values are defined by the Bluetooth SIG, please refer to - * https://specificationrefs.bluetooth.com/assigned-values/Appearance%20Values.pdf + * https://www.bluetooth.com/specifications/assigned-numbers/ * * @return * - ESP_OK : success diff --git a/docs/conf_common.py b/docs/conf_common.py index 3afbda32d7..6c379cfc4f 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -248,7 +248,11 @@ linkcheck_exclude_documents = ['index', # several false positives due to the wa linkcheck_ignore = ['https://webhome.phy.duke.edu/~rgb/General/dieharder.php', # Certificate error 'https://docs.espressif.com/projects/esptool/en/latest/esp32c2/espefuse/index.html', # Not published + 'https://docs.espressif.com/projects/esptool/en/latest/esp32c2/espsecure/index.html#remote-signing-using-an-external-hs', # Not published 'https://docs.espressif.com/projects/esptool/en/latest/esp32c6/espefuse/index.html', # Not published + 'https://docs.espressif.com/projects/esptool/en/latest/esp32c6/espsecure/index.html#remote-signing-using-an-external-hs', # Not published + 'https://docs.espressif.com/projects/esptool/en/latest/esp32h2/espefuse/index.html', # Not published + 'https://docs.espressif.com/projects/esptool/en/latest/esp32h2/espsecure/index.html#remote-signing-using-an-external-hs', # Not published 'https://www.cadence.com/content/dam/cadence-www/global/en_US/documents/tools/ip/tensilica-ip/isa-summary.pdf', # Rejects user-agent ] diff --git a/docs/en/api-reference/peripherals/gpio/esp32.inc b/docs/en/api-reference/peripherals/gpio/esp32.inc index 20ae885599..e12f41b255 100644 --- a/docs/en/api-reference/peripherals/gpio/esp32.inc +++ b/docs/en/api-reference/peripherals/gpio/esp32.inc @@ -194,7 +194,7 @@ The table below provides more information on pin usage, and please note the comm .. note:: - - Strapping pin: GPIO0, GPIO2, GPIO5, GPIO12 (MTDI), and GPIO15 (MTDO) are strapping pins. For more infomation, please refer to `ESP32 datasheet `_. + - Strapping pin: GPIO0, GPIO2, GPIO5, GPIO12 (MTDI), and GPIO15 (MTDO) are strapping pins. For more infomation, please refer to `ESP32 datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_. - SPI0/1: GPIO6-11 and GPIO16-17 are usually connected to the SPI flash and PSRAM integrated on the module and therefore should not be used for other purposes. - JTAG: GPIO12-15 are usually used for inline debug. - GPI: GPIO34-39 can only be set as input mode and do not have software-enabled pullup or pulldown functions. diff --git a/docs/en/api-reference/peripherals/gpio/esp32c3.inc b/docs/en/api-reference/peripherals/gpio/esp32c3.inc index ffff260a8b..d6d1f5d966 100644 --- a/docs/en/api-reference/peripherals/gpio/esp32c3.inc +++ b/docs/en/api-reference/peripherals/gpio/esp32c3.inc @@ -112,7 +112,7 @@ The table below provides more information on pin usage, and please note the comm .. note:: - - Strapping pin: GPIO2, GPIO8 and GPIO9 are strapping pins. For more infomation, please refer to `ESP32-C3 datasheet `_. + - Strapping pin: GPIO2, GPIO8 and GPIO9 are strapping pins. For more infomation, please refer to `ESP32-C3 datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_. - SPI0/1: GPIO12-17 are usually used for SPI flash and PSRAM and are not recommended for other uses. - USB-JTAG: GPIO 18 and 19 are used by USB-JTAG by default. In order to use them as GPIOs, USB-JTAG will be disabled by the drivers. - RTC: GPIO0-5 can be used when in Deep-sleep mode. diff --git a/docs/en/api-reference/peripherals/gpio/esp32c6.inc b/docs/en/api-reference/peripherals/gpio/esp32c6.inc index d443b9a59c..8fda4bbfb4 100644 --- a/docs/en/api-reference/peripherals/gpio/esp32c6.inc +++ b/docs/en/api-reference/peripherals/gpio/esp32c6.inc @@ -179,7 +179,7 @@ The table below provides more information on pin usage, and please note the comm .. note:: - - Strapping pin: GPIO4, GPIO5, GPIO8, GPIO9, and GPIO15 are strapping pins. For more infomation, please refer to `ESP32C6 datasheet `_. + - Strapping pin: GPIO4, GPIO5, GPIO8, GPIO9, and GPIO15 are strapping pins. For more infomation, please refer to `datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`__. - SPI0/1: GPIO24-30 are usually used for SPI flash and not recommended for other uses. - USB-JTAG: GPIO 12 and 13 are used by USB-JTAG by default. In order to use them as GPIOs, USB-JTAG will be disabled by the drivers. - For chip variants with an SiP flash built in, GPIO24 ~ GPIO30 are dedicated to connecting the SiP flash; GPIO10 ~ GPIO11 are not led out to any chip pins; therefore, only the remaining 22 GPIO pins are available. diff --git a/docs/en/api-reference/peripherals/gpio/esp32h2.inc b/docs/en/api-reference/peripherals/gpio/esp32h2.inc index 7dffaa2986..eb52c533d3 100644 --- a/docs/en/api-reference/peripherals/gpio/esp32h2.inc +++ b/docs/en/api-reference/peripherals/gpio/esp32h2.inc @@ -135,7 +135,7 @@ The table below provides more information on pin usage, and please note the comm .. note:: - - Strapping pin: GPIO2, GPIO3, GPIO8, GPIO9, and GPIO25 are strapping pins. For more infomation, please refer to `ESP32H2 datasheet `_. + - Strapping pin: GPIO2, GPIO3, GPIO8, GPIO9, and GPIO25 are strapping pins. For more infomation, please refer to `ESP32H2 datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_. - SPI0/1: GPIO15-21 are usually used for SPI flash and not recommended for other uses. - USB-Serial-JTAG: GPIO 26 and 27 are used by USB-Serial-JTAG by default. In order to use them as GPIOs, USB-Serial-JTAG will be disabled by the drivers. - For chip variants with an SiP flash built in, GPIO15 ~ GPIO21 are dedicated to connecting the SiP flash and are not fan-out to the external pins. In addition, GPIO6 ~ GPIO7 are also not fan-out to the external pins. In conclusion, only GPIO0~ GPIO5, GPIO8~ GPIO14, GPIO22~ GPIO27 are available to users. diff --git a/docs/en/api-reference/peripherals/gpio/esp32s2.inc b/docs/en/api-reference/peripherals/gpio/esp32s2.inc index 2e979a2d1d..2959e25838 100644 --- a/docs/en/api-reference/peripherals/gpio/esp32s2.inc +++ b/docs/en/api-reference/peripherals/gpio/esp32s2.inc @@ -239,7 +239,7 @@ The table below provides more information on pin usage, and please note the comm .. note:: - - Strapping pin: GPIO0, GPIO45 and GPIO46 are strapping pins. For more infomation, please refer to `ESP32-S2 datasheet `_ + - Strapping pin: GPIO0, GPIO45 and GPIO46 are strapping pins. For more infomation, please refer to `ESP32-S2 datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_ - SPI0/1: GPIO26-32 are usually used for SPI flash and PSRAM and not recommended for other uses. - JTAG: GPIO39-42 are usually used for inline debug. - GPI: GPIO46 is fixed to pull-down and is input only. diff --git a/docs/en/api-reference/peripherals/gpio/esp32s3.inc b/docs/en/api-reference/peripherals/gpio/esp32s3.inc index cce45d8b1b..2f689a2bfb 100644 --- a/docs/en/api-reference/peripherals/gpio/esp32s3.inc +++ b/docs/en/api-reference/peripherals/gpio/esp32s3.inc @@ -249,7 +249,7 @@ The table below provides more information on pin usage, and please note the comm .. Note:: - - Strapping pin: GPIO0, GPIO3, GPIO45 and GPIO46 are strapping pins. For more infomation, please refer to `ESP32-S3 datasheet `_. + - Strapping pin: GPIO0, GPIO3, GPIO45 and GPIO46 are strapping pins. For more infomation, please refer to `ESP32-S3 datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_. - SPI0/1: GPIO26-32 are usually used for SPI flash and PSRAM and not recommended for other uses. When using Octal Flash or Octal PSRAM or both, GPIO33~37 are connected to SPIIO4 ~ SPIIO7 and SPIDQS. Therefore, on boards embedded with ESP32-S3R8 / ESP32-S3R8V chip, GPIO33~37 are also not recommended for other uses. - USB-JTAG: GPIO 19 and 20 are used by USB-JTAG by default. In order to use them as GPIOs, USB-JTAG will be disabled by the drivers. diff --git a/docs/zh_CN/api-guides/app_trace.rst b/docs/zh_CN/api-guides/app_trace.rst index f72329b0b9..70d8c6c7ba 100644 --- a/docs/zh_CN/api-guides/app_trace.rst +++ b/docs/zh_CN/api-guides/app_trace.rst @@ -444,7 +444,7 @@ Start 子命令语法： 6. 双击创建的端口，会打开此端口的视图。 7. 单击 ``Start/Stop Streaming`` 按钮，数据将会被加载。 8. 使用 ``Zoom Out``，``Zoom In`` 和 ``Zoom Fit`` 按钮来查看数据。 - 9. 有关设置测量光标和其他的功能，请参阅 `Impulse 官方文档 `_ 。 + 9. 有关设置测量光标和其他的功能，请参阅 `Impulse 官方文档 `_ 。 .. note:: diff --git a/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst b/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst index 0d5fa312ca..7d26ec1e3b 100644 --- a/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst @@ -67,7 +67,7 @@ ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。 - 复位按键。 * - Boot - 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 - * - USB-to-UART 桥接器 + * - USB-to-UART 桥接器 - 单芯片 USB-UART 桥接器，可提供高达 3 Mbps 的传输速率。 * - Micro USB 接口。 - USB 接口，可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 @@ -208,7 +208,7 @@ ESP32-DevKitC V4 上电前，请首先确认开发板完好无损。 * `《ESP32-WROOM-32 技术规格书》 `_ (PDF) * `《ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书》 `_ (PDF) * `《ESP32-WROOM-DA 技术规格书》 `_ (PDF) -* `《ESP32-WROVER 技术规格书》 `_ (PDF) +* `《ESP32-WROVER 技术规格书》 `_ (PDF) * `《ESP32-WROVER-B 技术规格书》 `_ (PDF) * `乐鑫产品选型工具 `_ diff --git a/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v3.rst b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v3.rst index ad715d270e..02ecbb019c 100644 --- a/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v3.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v3.rst @@ -362,7 +362,7 @@ USB 供电 使能 UART 通信 * `ESP-WROVER-KIT V3 原理图`_ (PDF) * `《ESP32 技术规格书》 `_ (PDF) -* `《ESP32-WROVER 技术规格书》 `_ (PDF) +* `《ESP32-WROVER 技术规格书》 `_ (PDF) * `《ESP32-WROOM-32 技术规格书》 `_ (PDF) * :doc:`../../api-guides/jtag-debugging/index` * :doc:`../../hw-reference/index` diff --git a/docs/zh_CN/hw-reference/esp32/user-guide-devkits-r-v1.1.rst b/docs/zh_CN/hw-reference/esp32/user-guide-devkits-r-v1.1.rst index 390a7fa0af..6b3e1f85d4 100644 --- a/docs/zh_CN/hw-reference/esp32/user-guide-devkits-r-v1.1.rst +++ b/docs/zh_CN/hw-reference/esp32/user-guide-devkits-r-v1.1.rst @@ -264,6 +264,6 @@ R19 CLK SD_CLK - `ESP32-WROOM-32 技术规格书 `_ (PDF) - `ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书 `_ (PDF) - `ESP32-SOLO-1 技术规格书 `_ (PDF) -- `ESP32-WROVER 技术规格书 `_ (PDF) +- `ESP32-WROVER 技术规格书 `_ (PDF) - `ESP32-WROVER-B 技术规格书 `_ (PDF) - `乐鑫产品选型工具 `__