From 13b6482d4510c9b1680cad135490a2a41b1e4953 Mon Sep 17 00:00:00 2001 From: Doanh in Windowns Date: Mon, 5 Feb 2018 14:39:20 +0700 Subject: [PATCH 1/2] fix links for read the docs --- doc/esp8266wifi/readme.rst | 2 +- doc/faq/a02-my-esp-crashes.rst | 4 ++-- doc/faq/a04-board-generic-is-unknown.rst | 6 +++--- doc/reference.rst | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/esp8266wifi/readme.rst b/doc/esp8266wifi/readme.rst index bf9156ce1e..d94e671abc 100644 --- a/doc/esp8266wifi/readme.rst +++ b/doc/esp8266wifi/readme.rst @@ -302,7 +302,7 @@ The same sketch without ``Serial.setDebugOutput(true)`` will print out only the Enable Debugging in IDE ~~~~~~~~~~~~~~~~~~~~~~~ -Arduino IDE provides convenient method to `enable debugging `__ for specific libraries. +Arduino IDE provides convenient method to `enable debugging <../TroubleShooting/debugging.rst>`__ for specific libraries. What's Inside? -------------- diff --git a/doc/faq/a02-my-esp-crashes.rst b/doc/faq/a02-my-esp-crashes.rst index a25ac26e6b..c4e7753d6e 100644 --- a/doc/faq/a02-my-esp-crashes.rst +++ b/doc/faq/a02-my-esp-crashes.rst @@ -83,7 +83,7 @@ is wrong, it restarts itself to tell you about it. There are two typical scenarios that trigger ESP restarts: - **Exception** - when code is performing `illegal - operation `__, + operation <../exception_causes.rst>`__, like trying to write to non-existent memory location. - **Watchdog** - if code is `locked up `__ staying too long @@ -104,7 +104,7 @@ Typical restart because of exception looks like follows: Exception cause decoding Start with looking up exception code in the `Exception Causes -(EXCCAUSE) `__ +(EXCCAUSE) <../exception_causes.rst>`__ 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 Exception Stack Trace diff --git a/doc/faq/a04-board-generic-is-unknown.rst b/doc/faq/a04-board-generic-is-unknown.rst index ed5b00b35c..3c26d37bbd 100644 --- a/doc/faq/a04-board-generic-is-unknown.rst +++ b/doc/faq/a04-board-generic-is-unknown.rst @@ -54,15 +54,15 @@ follows: Error compiling for board Generic ESP8266 Module. Below is an example messages for -`WeMos `__: +`WeMos <../boards.rst#wemos-d1-r2-mini>`__: :: Board d1_mini (platform esp8266, package esp8266) is unknown Error compiling for board WeMos D1 R2 & mini. -... and another one for `Adafruit -HUZZAH `__: +... and another one for `Adafruit Feather +HUZZAH <../boards.rst#adafruit-feather-huzzah-esp8266>`__: :: diff --git a/doc/reference.rst b/doc/reference.rst index 642a729200..053d75d776 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -149,7 +149,7 @@ current speed. For example | ``Serial`` and ``Serial1`` objects are both instances of the ``HardwareSerial`` class. | I've done this also for official ESP8266 `Software - Serial `__ + Serial `__ library, see this `pull request `__. | Note that this implementation is **only for ESP8266 based boards**, From d56a5e90e173312e4d19f78081cd36fd9c3181fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Doanh=20V=C4=83n=20L=C6=B0=C6=A1ng?= Date: Thu, 8 Feb 2018 08:53:53 +0700 Subject: [PATCH 2/2] fix typo fix typo in link --- doc/esp8266wifi/readme.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/esp8266wifi/readme.rst b/doc/esp8266wifi/readme.rst index d94e671abc..58334a1bf3 100644 --- a/doc/esp8266wifi/readme.rst +++ b/doc/esp8266wifi/readme.rst @@ -302,7 +302,7 @@ The same sketch without ``Serial.setDebugOutput(true)`` will print out only the Enable Debugging in IDE ~~~~~~~~~~~~~~~~~~~~~~~ -Arduino IDE provides convenient method to `enable debugging <../TroubleShooting/debugging.rst>`__ for specific libraries. +Arduino IDE provides convenient method to `enable debugging <../Troubleshooting/debugging.rst>`__ for specific libraries. What's Inside? --------------