arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-19 23:22:16 +03:00
Code

fix links for read the docs (#4293)

Browse Source 
* fix links for read the docs

* fix typo

fix typo in link
This commit is contained in:
Doanh Văn Lương 2018-02-08 11:17:36 +07:00 committed by Develo
parent bb5787a1cd
commit f6f977fb03
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/esp8266wifi/readme.rst
View File

@ -302,7 +302,7 @@ The same sketch without ``Serial.setDebugOutput(true)`` will print out only the
Enable Debugging in IDE Enable Debugging in IDE
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
Arduino IDE provides convenient method to `enable debugging <https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst>`__ for specific libraries. Arduino IDE provides convenient method to `enable debugging <../Troubleshooting/debugging.rst>`__ for specific libraries.
What's Inside? What's Inside?
-------------- --------------

4
doc/faq/a02-my-esp-crashes.rst
View File

@ -83,7 +83,7 @@ is wrong, it restarts itself to tell you about it.
There are two typical scenarios that trigger ESP restarts: There are two typical scenarios that trigger ESP restarts:
- **Exception** - when code is performing `illegal - **Exception** - when code is performing `illegal
operation <https://github.com/esp8266/Arduino/blob/master/doc/exception_causes.rst>`__, operation <../exception_causes.rst>`__,
like trying to write to non-existent memory location. like trying to write to non-existent memory location.
- **Watchdog** - if code is `locked - **Watchdog** - if code is `locked
up <https://en.wikipedia.org/wiki/Watchdog_timer>`__ staying too long up <https://en.wikipedia.org/wiki/Watchdog_timer>`__ staying too long
@ -104,7 +104,7 @@ Typical restart because of exception looks like follows:
Exception cause decoding Exception cause decoding
Start with looking up exception code in the `Exception Causes Start with looking up exception code in the `Exception Causes
(EXCCAUSE) <https://github.com/esp8266/Arduino/blob/master/doc/exception_causes.rst>`__ (EXCCAUSE) <../exception_causes.rst>`__
table to understand what kind of issue it is. If you have no clues what table to understand what kind of issue it is. If you have no clues what
it's about and where it happens, then use `Arduino ESP8266/ESP32 it's about and where it happens, then use `Arduino ESP8266/ESP32
Exception Stack Trace Exception Stack Trace

6
doc/faq/a04-board-generic-is-unknown.rst
View File

@ -54,15 +54,15 @@ follows:
Error compiling for board Generic ESP8266 Module. Error compiling for board Generic ESP8266 Module.
Below is an example messages for Below is an example messages for
`WeMos <https://github.com/esp8266/Arduino/blob/master/doc/boards.rst#wemos-d1>`__: `WeMos <../boards.rst#wemos-d1-r2-mini>`__:
:: ::
Board d1_mini (platform esp8266, package esp8266) is unknown Board d1_mini (platform esp8266, package esp8266) is unknown
Error compiling for board WeMos D1 R2 & mini. Error compiling for board WeMos D1 R2 & mini.
... and another one for `Adafruit ... and another one for `Adafruit Feather
HUZZAH <https://github.com/esp8266/Arduino/blob/master/doc/boards.rst#adafruit-huzzah-esp8266-esp-12>`__: HUZZAH <../boards.rst#adafruit-feather-huzzah-esp8266>`__:
:: ::

2
doc/reference.rst
View File

@ -149,7 +149,7 @@ current speed. For example
| ``Serial`` and ``Serial1`` objects are both instances of the | ``Serial`` and ``Serial1`` objects are both instances of the
``HardwareSerial`` class. ``HardwareSerial`` class.
| I've done this also for official ESP8266 `Software | I've done this also for official ESP8266 `Software
Serial <https://github.com/esp8266/Arduino/blob/master/doc/libraries.rst#softwareserial>`__ Serial <libraries.rst#softwareserial>`__
library, see this `pull library, see this `pull
request <https://github.com/plerup/espsoftwareserial/pull/22>`__. request <https://github.com/plerup/espsoftwareserial/pull/22>`__.
| Note that this implementation is **only for ESP8266 based boards**, | Note that this implementation is **only for ESP8266 based boards**,