diff options
| author | Damien George <damien.p.george@gmail.com> | 2018-09-27 17:27:57 +1000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2018-10-01 13:53:53 +1000 |
| commit | b3e013f60ec0feb5b64bcadb45b154d093731c97 (patch) | |
| tree | cb0f4b4368d024b2cfa6044027e871304d3bdd82 /docs/esp8266 | |
| parent | 5cc9517fc5d2524aa53dbf40854ac33d27f238ca (diff) | |
| download | micropython-b3e013f60ec0feb5b64bcadb45b154d093731c97.tar.gz micropython-b3e013f60ec0feb5b64bcadb45b154d093731c97.zip | |
docs: Unify all the ports into one set of documentation.
With this commit there is now only one entry point into the whole
documentation, which describes the general MicroPython language, and then
from there there are links to information about specific platforms/ports.
This commit doesn't change content (almost, it does fix a few internal
links), it just reorganises things.
Diffstat (limited to 'docs/esp8266')
| -rw-r--r-- | docs/esp8266/general.rst | 2 | ||||
| -rw-r--r-- | docs/esp8266/quickref.rst | 11 | ||||
| -rw-r--r-- | docs/esp8266/tutorial/index.rst | 2 |
3 files changed, 13 insertions, 2 deletions
diff --git a/docs/esp8266/general.rst b/docs/esp8266/general.rst index fe1cdc1c65..020e21df62 100644 --- a/docs/esp8266/general.rst +++ b/docs/esp8266/general.rst @@ -1,3 +1,5 @@ +.. _esp8266_general: + General information about the ESP8266 port ========================================== diff --git a/docs/esp8266/quickref.rst b/docs/esp8266/quickref.rst index c510e40640..95ae55b570 100644 --- a/docs/esp8266/quickref.rst +++ b/docs/esp8266/quickref.rst @@ -1,4 +1,4 @@ -.. _quickref: +.. _esp8266_quickref: Quick reference for the ESP8266 =============================== @@ -9,6 +9,15 @@ Quick reference for the ESP8266 The Adafruit Feather HUZZAH board (image attribution: Adafruit). +Below is a quick reference for ESP8266-based boards. If it is your first time +working with this board please consider reading the following sections first: + +.. toctree:: + :maxdepth: 1 + + general.rst + tutorial/index.rst + Installing MicroPython ---------------------- diff --git a/docs/esp8266/tutorial/index.rst b/docs/esp8266/tutorial/index.rst index 39b4592600..0a4b5f2a66 100644 --- a/docs/esp8266/tutorial/index.rst +++ b/docs/esp8266/tutorial/index.rst @@ -1,4 +1,4 @@ -.. _tutorial-index: +.. _esp8266_tutorial: MicroPython tutorial for ESP8266 ================================ |