docs: fix formatting and some links

igrr · igrr · commit e63e772e6396 · 2017-02-20T22:39:20.000+08:00
diff --git a/doc/Troubleshooting/stack_dump.rst b/doc/Troubleshooting/stack_dump.rst
@@ -51,7 +51,7 @@ Example:
     <<<stack<<<
 
 The first number after ``Exception`` gives the cause of the reset. a
-full ist of all causes can be found `here <../exception_causes.md>`__
+full ist of all causes can be found :doc:`here <../exception_causes>`
 the hex after are the stack dump.
 
 Decode
diff --git a/doc/boards.rst b/doc/boards.rst
@@ -10,25 +10,12 @@ Adafruit HUZZAH ESP8266 (ESP-12)
 ESPresso Lite 1.0
 -----------------
 
-ESPresso Lite 1.0 (beta version) is an Arduino-compatible Wi-Fi
-development board powered by Espressif System's own ESP8266 WROOM-02
-module. It has breadboard-friendly breakout pins with in-built LED, two
-reset/flash buttons and a user programmable button . The operating
-voltage is 3.3VDC, regulated with 800mA maximum current. Special
-distinctive features include on-board I2C pads that allow direct
-connection to OLED LCD and sensor boards.
+ESPresso Lite 1.0 (beta version) is an Arduino-compatible Wi-Fi development board powered by Espressif System's own ESP8266 WROOM-02 module. It has breadboard-friendly breakout pins with in-built LED, two reset/flash buttons and a user programmable button . The operating voltage is 3.3VDC, regulated with 800mA maximum current. Special distinctive features include on-board I2C pads that allow direct connection to OLED LCD and sensor boards.
 
 ESPresso Lite 2.0
 -----------------
 
-ESPresso Lite 2.0 is an Arduino-compatible Wi-Fi development board based
-on an earlier V1 (beta version). Re-designed together with Cytron
-Technologies, the newly-revised ESPresso Lite V2.0 features the
-auto-load/auto-program function, eliminating the previous need to reset
-the board manually before flashing a new program. It also feature two
-user programmable side buttons and a reset button. The special
-distinctive features of on-board pads for I2C sensor and actuator is
-retained.
+ESPresso Lite 2.0 is an Arduino-compatible Wi-Fi development board based on an earlier V1 (beta version). Re-designed together with Cytron Technologies, the newly-revised ESPresso Lite V2.0 features the auto-load/auto-program function, eliminating the previous need to reset the board manually before flashing a new program. It also feature two user programmable side buttons and a reset button. The special distinctive features of on-board pads for I2C sensor and actuator is retained.
 
 Phoenix 1.0
 -----------
@@ -46,8 +33,7 @@ NodeMCU 0.9
 Pin mapping
 ~~~~~~~~~~~
 
-Pin numbers written on the board itself do not correspond to ESP8266
-GPIO pin numbers. Constants are defined to make using this board easier:
+Pin numbers written on the board itself do not correspond to ESP8266 GPIO pin numbers. Constants are defined to make using this board easier:
 
 .. code:: c++
 
@@ -63,88 +49,59 @@ GPIO pin numbers. Constants are defined to make using this board easier:
     static const uint8_t D9   = 3;
     static const uint8_t D10  = 1;
 
-If you want to use NodeMCU pin 5, use D5 for pin number, and it will be
-translated to 'real' GPIO pin 14.
+If you want to use NodeMCU pin 5, use D5 for pin number, and it will be translated to 'real' GPIO pin 14.
 
 NodeMCU 1.0
 -----------
 
-This module is sold under many names for around $6.50 on AliExpress and
-it's one of the cheapest, fully integrated ESP8266 solutions.
+This module is sold under many names for around $6.50 on AliExpress and it's one of the cheapest, fully integrated ESP8266 solutions.
 
 It's an open hardware design with an ESP-12E core and 4 MB of SPI flash.
 
-Acording to the manufacturer, "with a micro USB cable, you can connect
-NodeMCU devkit to your laptop and flash it without any trouble". This is
-more or less true: the board comes with a CP2102 onboard USB to serial
-adapter which just works, well, the majority of the time. Sometimes
-flashing fails and you have to reset the board by holding down FLASH +
-RST, then releasing FLASH, then releasing RST. This forces the CP2102
-device to power cycle and to be re-numbered by Linux.
+Acording to the manufacturer, "with a micro USB cable, you can connect NodeMCU devkit to your laptop and flash it without any trouble". This is more or less true: the board comes with a CP2102 onboard USB to serial adapter which just works, well, the majority of the time. Sometimes flashing fails and you have to reset the board by holding down FLASH +
+RST, then releasing FLASH, then releasing RST. This forces the CP2102 device to power cycle and to be re-numbered by Linux.
 
-The board also features a NCP1117 voltage regulator, a blue LED on
-GPIO16 and a 220k/100k Ohm voltage divider on the ADC input pin.
+The board also features a NCP1117 voltage regulator, a blue LED on GPIO16 and a 220k/100k Ohm voltage divider on the ADC input pin.
 
-Full pinout and PDF schematics can be found
-`here <https://github.com./nodemcu/nodemcu-devkit-v1.0>`__
+Full pinout and PDF schematics can be found `here <https://github.com./nodemcu/nodemcu-devkit-v1.0>`__
 
 Olimex MOD-WIFI-ESP8266-DEV
 ---------------------------
 
-This board comes with 2 MB of SPI flash and optional accessories (e.g.
-evaluation board ESP8266-EVB or BAT-BOX for batteries).
+This board comes with 2 MB of SPI flash and optional accessories (e.g. evaluation board ESP8266-EVB or BAT-BOX for batteries).
 
-The basic module has three solder jumpers that allow you to switch the
-operating mode between SDIO, UART and FLASH.
+The basic module has three solder jumpers that allow you to switch the operating mode between SDIO, UART and FLASH.
 
-The board is shipped for FLASH operation mode, with jumpers TD0JP=0,
-IO0JP=1, IO2JP=1.
+The board is shipped for FLASH operation mode, with jumpers TD0JP=0, IO0JP=1, IO2JP=1.
 
-Since jumper IO0JP is tied to GPIO0, which is PIN 21, you'll have to
-ground it before programming with a USB to serial adapter and reset the
-board by power cycling it.
+Since jumper IO0JP is tied to GPIO0, which is PIN 21, you'll have to ground it before programming with a USB to serial adapter and reset the board by power cycling it.
 
-UART pins for programming and serial I/O are GPIO1 (TXD, pin 3) and
-GPIO3 (RXD, pin 4).
+UART pins for programming and serial I/O are GPIO1 (TXD, pin 3) and GPIO3 (RXD, pin 4).
 
-You can find the board schematics
-`here <https://github.com./OLIMEX/ESP8266/blob/master/HARDWARE/MOD-WIFI-ESP8266-DEV/MOD-WIFI-ESP8266-DEV_schematic.pdf>`__
+You can find the board schematics `here <https://github.com./OLIMEX/ESP8266/blob/master/HARDWARE/MOD-WIFI-ESP8266-DEV/MOD-WIFI-ESP8266-DEV_schematic.pdf>`__
 
 Olimex MOD-WIFI-ESP8266
 -----------------------
 
-This is a stripped down version of the above. Behaves identically in
-terms of jumpers but has less pins readily available for I/O. Still 2 MB
-of SPI flash.
+This is a stripped down version of the above. Behaves identically in terms of jumpers but has less pins readily available for I/O. Still 2 MB of SPI flash.
 
 Olimex ESP8266-EVB
 ------------------
 
-It's a Olimex MOD-WIFI-ESP8266-DEV module installed on the headers of a
-development board which features some breakout connectors, a button
-(GPIO0) and a relay (GPIO5).
+It's an Olimex MOD-WIFI-ESP8266-DEV module installed on the headers of a development board which features some breakout connectors, a button (GPIO0) and a relay (GPIO5).
 
-Programming is pretty straightforward: the board is supported in the
-Arduino IDE after `installing it via the Board
-Manager <https://github.com./esp8266/Arduino#installing-with-boards-manager>`__.
-To download a program you just have to connect GND/RX/TX from a
-serial/USB adapter to the UEXT connector and press the only button
-before applying power to enter UART mode.
+To download a program you have to connect GND/RX/TX from a serial/USB adapter to the UEXT connector and press the only button before applying power to enter UART mode.
 
-Don't connect 5V from the serial/USB adapter to the board or you won't
-be able to power cycle it for UART mode.
+Don't connect 5V from the serial/USB adapter to the board or you won't be able to power cycle it for UART mode.
 
-You can find the board schematics
-`here <https://github.com./OLIMEX/ESP8266/blob/master/HARDWARE/ESP8266-EVB/ESP8266-EVB_Rev_A.pdf>`__.
+You can find the board schematics `here <https://github.com./OLIMEX/ESP8266/blob/master/HARDWARE/ESP8266-EVB/ESP8266-EVB_Rev_A.pdf>`__.
 
-`This
-guide <https://www.olimex.com/Products/IoT/ESP8266-EVB/resources/ESP8266-EVB-how-to-use-Arduino.pdf>`__
-is also useful for the first setup, since it contains the UEXT connector
-pinout.
+`This guide <https://www.olimex.com/Products/IoT/ESP8266-EVB/resources/ESP8266-EVB-how-to-use-Arduino.pdf>`__ is also useful for the first setup, since it contains the UEXT connector pinout.
 
-Board variants include: \* ESP8266-EVB-BAT: comes with built-in LiPo
-charger and step-up converter \* ESP8266-EVB-BAT-BOX: as above, but
-enclosd in a plastic box (non-weatherproof)
+Board variants include:
+
+* ESP8266-EVB-BAT: comes with built-in LiPo charger and step-up converter
+* ESP8266-EVB-BAT-BOX: as above, but enclosd in a plastic box (non-weatherproof)
 
 SparkFun ESP8266 Thing
 ----------------------
@@ -161,75 +118,46 @@ SweetPea ESP-210
 ESPino
 ------
 
-ESPino integrates the ESP-12 module with a 3.3v regulator, CP2104
-USB-Serial bridge and a micro USB connector for easy programming. It is
-designed for fitting in a breadboard and has an RGB Led and two buttons
-for easy prototyping.
+ESPino integrates the ESP-12 module with a 3.3v regulator, CP2104 USB-Serial bridge and a micro USB connector for easy programming. It is designed for fitting in a breadboard and has an RGB Led and two buttons for easy prototyping.
 
-For more information about the hardware, pinout diagram and programming
-procedures, please see the
-`datasheet <https://github.com./makerlabmx/ESPino-tools/raw/master/Docs/ESPino-Datasheet-EN.pdf>`__.
+For more information about the hardware, pinout diagram and programming procedures, please see the `datasheet <https://github.com./makerlabmx/ESPino-tools/raw/master/Docs/ESPino-Datasheet-EN.pdf>`__.
 
 Product page: http://www.espino.io/en
 
 WifInfo
 -------
 
-WifInfo integrates the ESP-12 or ESP-07+Ext antenna module with a 3.3v
-regulator and the hardware to be able to measure French telemetry issue
-from ERDF powering meter serial output. It has a USB connector for
-powering, an RGB WS2812 Led, 4 pins I2C connector to fit OLED or sensor,
-and two buttons + FTDI connector and auto reset feature.
+WifInfo integrates the ESP-12 or ESP-07+Ext antenna module with a 3.3v regulator and the hardware to be able to measure French telemetry issue from ERDF powering meter serial output. It has a USB connector for powering, an RGB WS2812 Led, 4 pins I2C connector to fit OLED or sensor, and two buttons + FTDI connector and auto reset feature.
 
-For more information, please see WifInfo related
-`blog <http://hallard.me/category/wifinfo/>`__ entries,
-`github <https://github.com./hallard/WifInfo>`__ and
-`community <https://community.hallard.me/category/16/wifinfo>`__ forum.
+For more information, please see WifInfo related `blog <http://hallard.me/category/wifinfo/>`__ entries, `github <https://github.com./hallard/WifInfo>`__ and `community <https://community.hallard.me/category/16/wifinfo>`__ forum.
 
 Generic ESP8266 modules
 -----------------------
 
-These modules come in different form factors and pinouts. See the page
-at ESP8266 community wiki for more info: `ESP8266 Module
-Family <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`__.
+These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info: `ESP8266 Module Family <http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family>`__.
 
-Usually these modules have no bootstapping resistors on board,
-insufficient decoupling capacitors, no voltage regulator, no reset
-circuit, and no USB-serial adapter. This makes using them somewhat
-tricky, compared to development boards which add these features.
+Usually these modules have no bootstapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features.
 
 In order to use these modules, make sure to observe the following:
 
--  **Provide sufficient power to the module.** For stable use of the
-   ESP8266 a power supply with 3.3V and >= 250mA is required. Using the
-   power available from USB to Serial adapter is not recommended, these
-   adapters typically do not supply enough current to run ESP8266
-   reliably in every situation. An external supply or regulator along
-   with filtering capacitors is preferred.
+-  **Provide sufficient power to the module.** For stable use of the ESP8266 a power supply with 3.3V and >= 250mA is required. Using the power available from USB to Serial adapter is not recommended, these adapters typically do not supply enough current to run ESP8266 reliably in every situation. An external supply or regulator alongwith filtering capacitors is preferred.
 
--  **Connect bootstapping resistors** to GPIO0, GPIO2, GPIO15 according
-   to the schematics below.
+-  **Connect bootstapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below.
 
 -  **Put ESP8266 into bootloader mode** before uploading code.
 
 Serial Adapter
 --------------
 
-There are many different USB to Serial adapters / boards. To be able to
-put ESP8266 into bootloader mode using serial handshaking lines, you
-need the adapter which breaks out RTS and DTR outputs. CTS and DSR are
-not useful for upload (they are inputs). Make sure the adapter can work
-with 3.3V IO voltage: it should have a jumper or a switch to select
-between 5V and 3.3V, or be marked as 3.3V only.
+There are many different USB to Serial adapters / boards. To be able to put ESP8266 into bootloader mode using serial handshaking lines, you need the adapter which breaks out RTS and DTR outputs. CTS and DSR are not useful for upload (they are inputs). Make sure the adapter can work with 3.3V IO voltage: it should have a jumper or a switch to select between 5V and 3.3V, or be marked as 3.3V only.
 
 Adapters based around the following ICs should work:
 
 -  FT232RL
 -  CP2102
 -  CH340G
 
-PL2303-based adapters are known not to work on Mac OS X. See
-https://github.com./igrr/esptool-ck/issues/9 for more info.
+PL2303-based adapters are known not to work on Mac OS X. See https://github.com./igrr/esptool-ck/issues/9 for more info.
 
 Minimal Hardware Setup for Bootloading and Usage
 ------------------------------------------------
@@ -338,8 +266,7 @@ Improved Stability
 Boot Messages and Modes
 -----------------------
 
-The ESP module checks at every boot the Pins 0, 2 and 15. based on them
-its boots in different modes:
+The ESP module checks at every boot the Pins 0, 2 and 15. based on them its boots in different modes:
 
 +----------+---------+---------+------------------------------------+
 | GPIO15   | GPIO0   | GPIO2   | Mode                               |
@@ -357,8 +284,7 @@ at startup the ESP prints out the current boot mode example:
 
     rst cause:2, boot mode:(3,6)
 
-note: - GPIO2 is used as TX output and the internal Pullup is enabled on
-boot.
+note: - GPIO2 is used as TX output and the internal Pullup is enabled on boot.
 
 rst cause
 ~~~~~~~~~
@@ -407,30 +333,24 @@ note: - number = ((GPIO15 << 2) \| (GPIO0 << 1) \| GPIO2);
 Generic ESP8285 modules
 -----------------------
 
-ESP8285
-(`datasheet <http://espressif.com/sites/default/files/documentation/0a-esp8285_datasheet_en_v1.0_20160422.pdf>`__)
-is a multi-chip package which contains ESP8266 and 1MB flash. All points
-related to bootstrapping resistors and recommended circuits listed above
-apply to ESP8285 as well.
+ESP8285 (`datasheet <http://www.espressif.com/sites/default/files/0a-esp8285_datasheet_en_v1.0_20160422.pdf>`__) is a multi-chip package which contains ESP8266 and 1MB flash. All points related to bootstrapping resistors and recommended circuits listed above apply to ESP8285 as well.
 
-Note that since ESP8285 has SPI flash memory internally connected in
-DOUT mode, pins 9 and 10 may be used as GPIO / I2C / PWM pins.
+Note that since ESP8285 has SPI flash memory internally connected in DOUT mode, pins 9 and 10 may be used as GPIO / I2C / PWM pins.
 
 WeMos D1
 --------
 
-Product page: http://wemos.cc
+Product page: https://www.wemos.cc/
 
 WeMos D1 mini
 -------------
 
-Product page: http://wemos.cc
+Product page: https://www.wemos.cc/
 
 ESPino (WROOM-02 Module) by ThaiEasyElec
 ----------------------------------------
 
-ESPino by ThaiEasyElec using WROOM-02 module from Espressif Systems with
-4 MB Flash.
+ESPino by ThaiEasyElec using WROOM-02 module from Espressif Systems with 4 MB Flash.
 
 We will update an English description soon. - Product page:
 http://thaieasyelec.com/products/wireless-modules/wifi-modules/espino-wifi-development-board-detail.html
@@ -439,5 +359,4 @@ www.thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_Schematic.pdf -
 Dimensions:
 http://thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_Dimension.pdf
 - Pinouts:
-http://thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_User\_Manual\_TH\_v1\_0\_20160204.pdf
-(Please see pg. 8)
+http://thaieasyelec.com/downloads/ETEE052/ETEE052\_ESPino\_User\_Manual\_TH\_v1\_0\_20160204.pdf (Please see pg. 8)
diff --git a/doc/conf.py b/doc/conf.py
@@ -152,6 +152,8 @@
      'Miscellaneous'),
 ]
 
+linkcheck_anchors_ignore = ["/#!"]
+
 # -- Use sphinx_rtd_theme for local builds --------------------------------
 # ref. https://github.com./snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs
 #
diff --git a/doc/eclipse/eclipse.rst b/doc/eclipse/eclipse.rst
@@ -12,7 +12,7 @@ What to Download
 Setup Arduino
 ~~~~~~~~~~~~~
 
-see the
+See the
 `Readme <https://github.com./esp8266/Arduino#installing-with-boards-manager>`__
 
 Setup Eclipse
diff --git a/doc/libraries.rst b/doc/libraries.rst

Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,8 @@`
`152`	`152`	`'Miscellaneous'),`
`153`	`153`	`]`
`154`	`154`
	`155`	`+linkcheck_anchors_ignore = ["/#!"]`
	`156`	`+`
`155`	`157`	`# -- Use sphinx_rtd_theme for local builds --------------------------------`
`156`	`158`	`# ref. https://github.com./snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs`
`157`	`159`	`#`