Skip to content

fix links for read the docs #4293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 8, 2018
Merged

fix links for read the docs #4293

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
13b6482
fix links for read the docs
Feb 5, 2018
970dad3
Merge branch 'master' into fix-links
tarzan115 Feb 6, 2018
b914f65
Merge branch 'master' into fix-links
devyte Feb 6, 2018
d11ba7d
Merge branch 'master' into fix-links
tarzan115 Feb 7, 2018
336ca7b
Merge branch 'master' into fix-links
tarzan115 Feb 7, 2018
50c6931
Merge branch 'master' into fix-links
devyte Feb 7, 2018
d56a5e9
fix typo
tarzan115 Feb 8, 2018
0321435
Merge branch 'master' into fix-links
tarzan115 Feb 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/esp8266wifi/readme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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?
--------------
Expand Down
4 changes: 2 additions & 2 deletions doc/faq/a02-my-esp-crashes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/esp8266/Arduino/blob/master/doc/exception_causes.rst>`__,
operation <../exception_causes.rst>`__,
like trying to write to non-existent memory location.
- **Watchdog** - if code is `locked
up <https://en.wikipedia.org/wiki/Watchdog_timer>`__ staying too long
Expand All @@ -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) <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
it's about and where it happens, then use `Arduino ESP8266/ESP32
Exception Stack Trace
Expand Down
6 changes: 3 additions & 3 deletions doc/faq/a04-board-generic-is-unknown.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ follows:
Error compiling for board Generic ESP8266 Module.

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
Error compiling for board WeMos D1 R2 & mini.

... and another one for `Adafruit
HUZZAH <https://github.com/esp8266/Arduino/blob/master/doc/boards.rst#adafruit-huzzah-esp8266-esp-12>`__:
... and another one for `Adafruit Feather
HUZZAH <../boards.rst#adafruit-feather-huzzah-esp8266>`__:

::

Expand Down
2 changes: 1 addition & 1 deletion doc/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/esp8266/Arduino/blob/master/doc/libraries.rst#softwareserial>`__
Serial <libraries.rst#softwareserial>`__
library, see this `pull
request <https://github.com/plerup/espsoftwareserial/pull/22>`__.
| Note that this implementation is **only for ESP8266 based boards**,
Expand Down