8000 fix dead link docs (#4221) · arduino/esp8266@4e11591 · GitHub
[go: up one dir, main page]
Skip to content

Commit 4e11591

Browse files
tarzan115devyte
tarzan115
authored and
devyte
committed
fix dead link docs (esp8266#4221)
1 parent 29c9ebe commit 4e11591

16 files changed

+32
-32
lines changed

‎doc/esp8266wifi/client-class.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ Other Function Calls
5959
Documentation for the above functions is not yet prepared.
6060

6161
For code samples please refer to separate section with `examples
62-
:arrow\_right: <client-examples.md>`__ dedicated specifically to the Client Class.
62+
:arrow\_right: <client-examples.rst>`__ dedicated specifically to the Client Class.

‎doc/esp8266wifi/client-examples.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This time we are going to concentrate just on retrieving a web page contents sen
2828
Get Connected to Wi-Fi
2929
~~~~~~~~~~~~~~~~~~~~~~
3030

31-
We should start with connecting the module to an access point to obtain an access to internet. The code to provide this functionality has been already discussed in chapter `Quick Start <readme.md#quick-start>`__. Please refer to it for details.
31+
We should start with connecting the module to an access point to obtain an access to internet. The code to provide this functionality has been already discussed in chapter `Quick Start <readme.rst#quick-start>`__. Please refer to it for details.
3232

3333
Select a Server
3434
~~~~~~~~~~~~~~~
@@ -257,4 +257,4 @@ For more client examples please check
257257

258258
- `WiFiClient.ino <https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/WiFiClient/WiFiClient.ino>`__ - this sketch sends data via HTTP GET requests to data.sparkfun.com service.
259259

260-
For the list of functions provided to manage clients, please refer to the `Client Class :arrow\_right: <client-class.md>`__ documentation.
260+
For the list of functions provided to manage clients, please refer to the `Client Class :arrow\_right: <client-class.rst>`__ documentation.

‎doc/esp8266wifi/client-secure-class.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ Other Function Calls
9898
9999
Documentation for the above functions is not yet prepared.
100100

101-
For code samples please refer to separate section with `examples <client-secure-examples.md>`__ dedicated specifically to the Client Secure Class.
101+
For code samples please refer to separate section with `examples <client-secure-examples.rst>`__ dedicated specifically to the Client Secure Class.

‎doc/esp8266wifi/client-secure-examples.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Client Secure
44
-------------
55

6-
The client secure is a `client <#client>`__ but secure. Application example below will be easier to follow if you check similar and simpler `example <client-examples.md>`__ for the "ordinary" client. That being said we will concentrate on discussing the code that is specific to the client secure.
6+
The client secure is a `client <#client>`__ but secure. Application example below will be easier to follow if you check similar and simpler `example <client-examples.rst>`__ for the "ordinary" client. That being said we will concentrate on discussing the code that is specific to the client secure.
77

88
Table of Contents
99
-----------------
@@ -71,7 +71,7 @@ We can obtain the ``fingerprint`` for specific ``host`` using a web browser. For
7171

7272
alt text
7373

74-
Remaining steps look almost identical as for the `non-secure client example <client-examples.md>`__.
74+
Remaining steps look almost identical as for the `non-secure client example <client-examples.rst>`__.
7575

7676
Connect to the Server
7777
~~~~~~~~~~~~~~~~~~~~~
@@ -106,7 +106,7 @@ If this check fails, it is up to you to decide if to proceed further or abort co
106106
GET Response from the Server
107107
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
108108

109-
In the next steps we should execute GET command. This is done is similar way as discussed in `non-secure client example <client-examples.md>`__.
109+
In the next steps we should execute GET command. This is done is similar way as discussed in `non-secure client example <client-examples.rst>`__.
110110

111111
.. code:: cpp
112112

‎doc/esp8266wifi/generic-class.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ WiFiEventHandler
2727
WiFiEventHandler onSoftAPModeStationConnected (std::function< void(const WiFiEventSoftAPModeStationConnected &)>)
2828
WiFiEventHandler onSoftAPModeStationDisconnected (std::function< void(const WiFiEventSoftAPModeStationDisconnected &)>)
2929
30-
To see a sample application with ``WiFiEventHandler``, please check separate section with `examples :arrow\_right: <generic-examples.md>`__ dedicated specifically to the Generic Class..
30+
To see a sample application with ``WiFiEventHandler``, please check separate section with `examples :arrow\_right: <generic-examples.rst>`__ dedicated specifically to the Generic Class..
3131

3232
persistent
3333
~~~~~~~~~~

‎doc/esp8266wifi/generic-examples.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Generic
44
-------
55

6-
In the first `example <readme.md#quick-start>`__ of the ESP8266WiFi library documentation we have discussed how to check when module connects to the Wi-Fi network. We were waiting until connection is established. If network is not available, the module could wait like that for ever doing nothing else. Another `example <scan-examples.md#async-scan>`__ on the Wi-Fi asynchronous scan mode demonstrated how to wait for scan result and do in parallel something else - blink a LED not disturbing the blink pattern. Let's apply similar functionality when connecting the module to an access point.
6+
In the first `example <readme.rst#quick-start>`__ of the ESP8266WiFi library documentation we have discussed how to check when module connects to the Wi-Fi network. We were waiting until connection is established. If network is not available, the module could wait like that for ever doing nothing else. Another `example <scan-examples.rst#async-scan>`__ on the Wi-Fi asynchronous scan mode demonstrated how to wait for scan result and do in parallel something else - blink a LED not disturbing the blink pattern. Let's apply similar functionality when connecting the module to an access point.
77

88
Table of Contents
99
-----------------
@@ -29,7 +29,7 @@ We would like to write a code that will inform us that connection to Wi-Fi netwo
2929
Event Driven Methods
3030
~~~~~~~~~~~~~~~~~~~~
3131

32-
The list of all such methods is provided in `Generic Class <generic-class.md>`__ documentation.
32+
The list of all such methods is provided in `Generic Class <generic-class.rst>`__ documentation.
3333

3434
We would like to use two of them: \* ``onStationModeGotIP`` called when station is assigned IP address. This assignment may be done by DHCP client or by executing ``WiFi.config(...)``. \* ``onStationModeDisconnected`` called when station is disconnected from Wi-Fi network. The reason of disconnection does not matter. Event will be triggered both if disconnection is done from the code by executing ``WiFi.disconnect()``, because the Wi-Fi signal is weak, or because the access point is switched off.
3535

@@ -122,4 +122,4 @@ Conclusion
122122

123123
Check out events from generic class. They will help you to write more compact code. Use them to practice splitting your code into separate tasks that are executed asynchronously.
124124

125-
For review of functions included in generic class, please refer to the `Generic Class <generic-class.md>`__ documentation.
125+
For review of functions included in generic class, please refer to the `Generic Class <generic-class.rst>`__ documentation.

‎doc/esp8266wifi/readme.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ The same sketch without ``Serial.setDebugOutput(true)`` will print out only the
302302
Enable Debugging in IDE
303303
~~~~~~~~~~~~~~~~~~~~~~~
304304

305-
Arduino IDE provides convenient method to `enable debugging <https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.md>`__ for specific libraries.
305+
Arduino IDE provides convenient method to `enable debugging <https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst>`__ for specific libraries.
306306

307307
What's Inside?
308308
--------------

‎doc/esp8266wifi/scan-class.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,4 +235,4 @@ The ``networkItem`` is a zero based index of network discovered during scan. All
235235
5: , Ch:11 (-77dBm) hidden
236236
6: UPC Wi-Free, Ch:11 (-79dBm)
237237

238-
For code samples please refer to separate section with `examples <scan-examples.md>`__ dedicated specifically to the Scan Class.
238+
For code samples please refer to separate section with `examples <scan-examples.rst>`__ dedicated specifically to the Scan Class.

‎doc/esp8266wifi/scan-examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,4 +240,4 @@ Conclusion
240240

241241
The scan class API provides comprehensive set of methods to do scanning in both synchronous as well as in asynchronous mode. Therefore we can easy implement code that is doing scanning in background without disturbing other processes running on ESP8266 module.
242242

243-
For the list of functions provided to manage scan mode please refer to the `Scan Class <scan-class.md>`__ documentation.
243+
For the list of functions provided to manage scan mode please refer to the `Scan Class <scan-class.rst>`__ documentation.

‎doc/esp8266wifi/station-examples.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Station
44
-------
55

6-
Example of connecting to an access point has been shown in chapter `Quick Start <readme.md#quick-start>`__. In case connection is lost, ESP8266 will automatically reconnect to the last used access point, once it is again available.
6+
Example of connecting to an access point has been shown in chapter `Quick Start <readme.rst#quick-start>`__. In case connection is lost, ESP8266 will automatically reconnect to the last used access point, once it is again available.
77

88
Can we provide more robust connection to Wi-Fi than that?
99

@@ -19,7 +19,7 @@ Table of Contents
1919
Introduction
2020
~~~~~~~~~~~~
2121

22-
Following the example in\ `Quick Start <readme.md#quick-start>`__, we would like to go one step further and made ESP connect to next available access point if current connection is lost. This functionality is provided with 'ESP8266WiFiMulti' class and demonstrated in sketch below.
22+
Following the example in\ `Quick Start <readme.rst#quick-start>`__, we would like to go one step further and made ESP connect to next available access point if current connection is lost. This functionality is provided with 'ESP8266WiFiMulti' class and demonstrated in sketch below.
2323

2424
.. code:: cpp
2525
@@ -100,7 +100,7 @@ Function ``monitorWiFi()`` is in place to show when connection is lost by displa
100100
Can we Make it Simpler?
101101
~~~~~~~~~~~~~~~~~~~~~~~
102102

103-
Please note that you may simplify this sketch by removing function ``monitorWiFi()`` and putting inside ``loop()`` only ``wifiMulti.run()``. ESP will still reconnect between configured access points if required. Now you won't be able to see it on serial monitor unless you add ``Serial.setDebugOutput(true)`` as described in point `Enable Wi-Fi Diagnostic <readme.md#enable-wi-fi-diagnostic>`__.
103+
Please note that you may simplify this sketch by removing function ``monitorWiFi()`` and putting inside ``loop()`` only ``wifiMulti.run()``. ESP will still reconnect between configured access points if required. Now you won't be able to see it on serial monitor unless you add ``Serial.setDebugOutput(true)`` as described in point `Enable Wi-Fi Diagnostic <readme.rst#enable-wi-fi-diagnostic>`__.
104104

105105
Updated sketch for such scenario will look as follows:
106106

0 commit comments

Comments
 (0)
0