From 90118531a75aa36e5c424193f6d55b6b398141ee Mon Sep 17 00:00:00 2001 From: Wang Fang Date: Thu, 25 Feb 2021 13:41:04 +0800 Subject: [PATCH] docs: fix broken example links for release v4.1 --- docs/en/api-reference/network/esp_netif.rst | 6 +++--- .../api-reference/network/tcpip_adapter_migration.rst | 6 +++--- docs/en/api-reference/protocols/asio.rst | 10 +++++----- docs/en/api-reference/storage/spiffs.rst | 2 +- .../api-reference/network/tcpip_adapter_migration.rst | 6 +++--- docs/zh_CN/api-reference/storage/spiffs.rst | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/en/api-reference/network/esp_netif.rst b/docs/en/api-reference/network/esp_netif.rst index ea159c08cf..77bb21c9f8 100644 --- a/docs/en/api-reference/network/esp_netif.rst +++ b/docs/en/api-reference/network/esp_netif.rst @@ -141,9 +141,9 @@ ESP-NETIF programmer's manual Please refer to the example section for basic initialization of default interfaces: -- WiFi Station: :example:`examples/wifi/getting_started/station/main/station_example_main.c` -- WiFi Access Point: :example:`examples/wifi/getting_started/softAP/main/softap_example_main.c` -- Ethernet :example:`examples/ethernet/basic/main/ethernet_example_main.c` +- WiFi Station: :example:`wifi/getting_started/station/main/station_example_main.c` +- WiFi Access Point: :example:`wifi/getting_started/softAP/main/softap_example_main.c` +- Ethernet: :example:`ethernet/basic/main/ethernet_example_main.c` For more specific cases please consult this guide: :doc:`/api-reference/network/esp_netif_driver`. diff --git a/docs/en/api-reference/network/tcpip_adapter_migration.rst b/docs/en/api-reference/network/tcpip_adapter_migration.rst index 6f476ac819..450930c265 100644 --- a/docs/en/api-reference/network/tcpip_adapter_migration.rst +++ b/docs/en/api-reference/network/tcpip_adapter_migration.rst @@ -31,9 +31,9 @@ Network interface instance shall be explicitly constructed for the :doc:`/api-re For example initialization code for WiFi has to explicitly call ``esp_netif_create_default_wifi_sta();`` or ``esp_netif_create_default_wifi_ap();`` after the TCP/IP stack and the event loop have been initialized. Please consult an example initialization code for these three interfaces: -- WiFi Station: :example:`examples/wifi/getting_started/station/main/station_example_main.c` -- WiFi Access Point: :example:`examples/wifi/getting_started/softAP/main/softap_example_main.c` -- Ethernet :example:`examples/ethernet/basic/main/ethernet_example_main.c` +- WiFi Station: :example:`wifi/getting_started/station/main/station_example_main.c` +- WiFi Access Point: :example:`wifi/getting_started/softAP/main/softap_example_main.c` +- Ethernet: :example:`ethernet/basic/main/ethernet_example_main.c` Replacing other tcpip_adapter API diff --git a/docs/en/api-reference/protocols/asio.rst b/docs/en/api-reference/protocols/asio.rst index dcf7041311..14f39ae485 100644 --- a/docs/en/api-reference/protocols/asio.rst +++ b/docs/en/api-reference/protocols/asio.rst @@ -21,11 +21,11 @@ Internal asio settings for ESP include Application Example ------------------- -ESP examples are based on standard asio :example:`examples/protocols/asio`: +ESP examples are based on standard asio :example:`protocols/asio`: -- :example:`examples/protocols/asio/udp_echo_server` -- :example:`examples/protocols/asio/tcp_echo_server` -- :example:`examples/protocols/asio/chat_client` -- :example:`examples/protocols/asio/chat_server` +- :example:`protocols/asio/udp_echo_server` +- :example:`protocols/asio/tcp_echo_server` +- :example:`protocols/asio/chat_client` +- :example:`protocols/asio/chat_server` Please refer to the specific example README.md for details diff --git a/docs/en/api-reference/storage/spiffs.rst b/docs/en/api-reference/storage/spiffs.rst index 4182c34f21..37fd6586e0 100644 --- a/docs/en/api-reference/storage/spiffs.rst +++ b/docs/en/api-reference/storage/spiffs.rst @@ -91,7 +91,7 @@ in CMake:: spiffs_create_partition_image(my_spiffs_partition my_folder DEPENDS dep) -+For an example, see :example:`examples/storage/spiffsgen>`. +For an example, see :example:`storage/spiffsgen`. mkspiffs diff --git a/docs/zh_CN/api-reference/network/tcpip_adapter_migration.rst b/docs/zh_CN/api-reference/network/tcpip_adapter_migration.rst index d55d896908..50404b68a5 100644 --- a/docs/zh_CN/api-reference/network/tcpip_adapter_migration.rst +++ b/docs/zh_CN/api-reference/network/tcpip_adapter_migration.rst @@ -32,9 +32,9 @@ TCP/IP 适配器静态定义了三个接口： 。 请参阅这三个接口的初始化代码示例： -- Wi-Fi Station：:example:`examples/wifi/getting_started/station/main/station_example_main.c` -- Wi-Fi AP：:example:`examples/wifi/getting_started/softAP/main/softap_example_main.c` -- 以太网 :example:`examples/ethernet/basic/main/ethernet_example_main.c` +- Wi-Fi Station：:example:`wifi/getting_started/station/main/station_example_main.c` +- Wi-Fi AP：:example:`wifi/getting_started/softAP/main/softap_example_main.c` +- 以太网：:example:`ethernet/basic/main/ethernet_example_main.c` 更换其他 tcpip_adapter API diff --git a/docs/zh_CN/api-reference/storage/spiffs.rst b/docs/zh_CN/api-reference/storage/spiffs.rst index 941cd423ba..05ac56042a 100644 --- a/docs/zh_CN/api-reference/storage/spiffs.rst +++ b/docs/zh_CN/api-reference/storage/spiffs.rst @@ -87,7 +87,7 @@ Make 构建系统和 CMake 构建系统结构有所不同，请注意以下几 spiffs_create_partition_image(my_spiffs_partition my_folder DEPENDS dep) -请参考 :example:`examples/storage/spiffsgen>`，查看示例。 +请参考 :example:`storage/spiffsgen`，查看示例。 mkspiffs ^^^^^^^^^^^