docs: fix warnings and toctrees

igrr · igrr · commit ba8af666f7d4 · 2017-02-19T17:36:25.000+08:00
diff --git a/doc/esp8266wifi/client-class.rst b/doc/esp8266wifi/client-class.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#client>`__
+:orphan:
 
 Client Class
 ------------
diff --git a/doc/esp8266wifi/client-examples.rst b/doc/esp8266wifi/client-examples.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#client>`__
+:orphan:
 
 Client
 ------
@@ -255,7 +255,6 @@ For more client examples please check
 
 - `WiFiClientBasic.ino <https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/WiFiClientBasic/WiFiClientBasic.ino>`__ - a simple sketch that sends a message to a TCP server
 
-- `WiFiClient.ino <https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/WiFiClient/WiFiClient.ino>`__ - this sketch sends data via HTTP GET requests to data.sparkfun.com
-service.
+- `WiFiClient.ino <https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/WiFiClient/WiFiClient.ino>`__ - this sketch sends data via HTTP GET requests to data.sparkfun.com service.
 
 For the list of functions provided to manage clients, please refer to the `Client Class :arrow\_right: <client-class.md>`__ documentation.
diff --git a/doc/esp8266wifi/client-secure-class.rst b/doc/esp8266wifi/client-secure-class.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#client-secure>`__
+:orphan:
 
 Client Secure Class
 -------------------
diff --git a/doc/esp8266wifi/client-secure-examples.rst b/doc/esp8266wifi/client-secure-examples.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#client-secure>`__
+:orphan:
 
 Client Secure
 -------------
diff --git a/doc/esp8266wifi/generic-class.rst b/doc/esp8266wifi/generic-class.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#generic>`__
+:orphan:
 
 Generic Class
 -------------
diff --git a/doc/esp8266wifi/generic-examples.rst b/doc/esp8266wifi/generic-examples.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#generic>`__
+:orphan:
 
 Generic
 -------
diff --git a/doc/esp8266wifi/readme.rst b/doc/esp8266wifi/readme.rst
@@ -1,23 +1,3 @@
-.. toctree::
-   :hidden:
-   
-   client-class
-   client-examples
-   client-secure-class
-   client-secure-examples
-   generic-class
-   generic-examples
-   scan-class
-   scan-examples
-   server-class
-   server-examples
-   soft-access-point-class
-   soft-access-point-examples
-   station-class
-   station-examples
-   udp-class
-   udp-examples
-
 ESP8266WiFi library
 ===================
 
diff --git a/doc/esp8266wifi/scan-class.rst b/doc/esp8266wifi/scan-class.rst
@@ -1,30 +1,10 @@
-`ESP8266WiFi Library :back: <readme.md#scan>`__
+:orphan:
 
 Scan Class
-----------
+~~~~~~~~~~
 
 This class is represented in `Arduino WiFi library <https://www.arduino.cc/en/Reference/WiFi>`__ by `scanNetworks() <https://www.arduino.cc/en/Reference/WiFiScanNetworks>`__ function. Developers of esp8266 / Arduino core extend this functionality by additional methods and properties.
 
-Table of Contents
------------------
-
--  `Scan for Networks <#scan-for-networks>`__
-
-   -  `scanNetworks <#scannetworks>`__
-   -  `scanNetworksAsync <#scannetworksasync>`__
-   -  `scanComplete <#scancomplete>`__
-   -  `scanDelete <#scandelete>`__
-
--  `Show Results <#show-results>`__
-
-   -  `SSID <#ssid>`__
-   -  `encryptionType <#encryptiontype>`__
-   -  `BSSID <#bssid>`__
-   -  `BSSIDstr <#bssidstr>`__
-   -  `channel <#channel>`__
-   -  `isHidden <#ishidden>`__
-   -  `getNetworkInfo <#getnetworkinfo>`__
-
 Documentation of this class is divided into two parts. First covers functions to scan for available networks. Second describes what information is collected during scanning process and how to access it.
 
 Scan for Networks
diff --git a/doc/esp8266wifi/scan-examples.rst b/doc/esp8266wifi/scan-examples.rst
@@ -1,31 +1,10 @@
-`ESP8266WiFi Library :back: <readme.md#scan>`__
+:orphan:
 
 Scan
 ~~~~
 
 To connect a mobile phone to a hot spot, you typically open Wi-Fi settings app, list available networks and then pick the hot spot you need. You can also list the networks with ESP8266 and here is how.
 
-Table of Contents
------------------
-
--  `Simple Scan <#simple-scan>`__
-
-   -  `Disconnect <#disconnect>`__
-   -  `Scan for Networks <#scan-for-networks>`__
-   -  `Complete Example <#complete-example>`__
-   -  `Example in Action <#example-in-action>`__
-
--  `Async Scan <#async-scan>`__
-
-   -  `No delay() <#no-delay>`__
-   -  `Setup <#setup>`__
-   -  `When to Start <#when-to-start>`__
-   -  `Check When Done <#check-when-done>`__
-   -  `Complete Example <#complete-example-1>`__
-   -  `Example in Action <#example-in-action-1>`__
-
--  `Conclusion <#conclusion>`__
-
 Simple Scan
 ~~~~~~~~~~~
 
diff --git a/doc/esp8266wifi/server-class.rst b/doc/esp8266wifi/server-class.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#server>`__
+:orphan:
 
 Server Class
 ------------
diff --git a/doc/esp8266wifi/server-examples.rst b/doc/esp8266wifi/server-examples.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#server>`__
+:orphan:
 
 Server
 ------
diff --git a/doc/esp8266wifi/soft-access-point-class.rst b/doc/esp8266wifi/soft-access-point-class.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#soft-access-point>`__
+:orphan:
 
 Soft Access Point Class
 -----------------------
diff --git a/doc/esp8266wifi/soft-access-point-examples.rst b/doc/esp8266wifi/soft-access-point-examples.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#soft-access-point>`__
+:orphan:
 
 Soft Access Point
 -----------------
diff --git a/doc/esp8266wifi/station-class.rst b/doc/esp8266wifi/station-class.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#station>`__
+:orphan:
 
 Station Class
 -------------
diff --git a/doc/esp8266wifi/station-examples.rst b/doc/esp8266wifi/station-examples.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#station>`__
+:orphan:
 
 Station
 -------
diff --git a/doc/esp8266wifi/udp-class.rst b/doc/esp8266wifi/udp-class.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#udp>`__
+:orphan:
 
 UDP Class
 ---------
diff --git a/doc/esp8266wifi/udp-examples.rst b/doc/esp8266wifi/udp-examples.rst
@@ -1,4 +1,4 @@
-`ESP8266WiFi Library :back: <readme.md#udp>`__
+:orphan:
 
 UDP
 ---
diff --git a/doc/faq/a01-espcomm_sync-failed.rst b/doc/faq/a01-espcomm_sync-failed.rst
@@ -1,4 +1,4 @@
-`FAQ list :back: <readme.md>`__
+:orphan:
 
 I am getting "espcomm\_sync failed" error when trying to upload my ESP. How to resolve this issue?
 --------------------------------------------------------------------------------------------------
diff --git a/doc/faq/a02-my-esp-crashes.rst b/doc/faq/a02-my-esp-crashes.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 My ESP crashes running some code. How to troubleshoot it?
 ---------------------------------------------------------
 
diff --git a/doc/faq/a03-library-does-not-work.rst b/doc/faq/a03-library-does-not-work.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 This Arduino library doesn't work on ESP. How do I make it working?
 -------------------------------------------------------------------
 
diff --git a/doc/faq/a04-board-generic-is-unknown.rst b/doc/faq/a04-board-generic-is-unknown.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 How to resolve "Board generic (platform esp8266, package esp8266) is unknown" error?
 ------------------------------------------------------------------------------------
 
diff --git a/doc/faq/readme.rst b/doc/faq/readme.rst
@@ -1,11 +1,3 @@
-.. toctree::
-   :hidden:
-
-   a01-espcomm_sync-failed
-   a02-my-esp-crashes
-   a03-library-does-not-work
-   a04-board-generic-is-unknown   
-
 FAQ
 ===
 
diff --git a/doc/ota_updates/readme.rst b/doc/ota_updates/readme.rst

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-`ESP8266WiFi Library :back: <readme.md#client>`__
	`1`	`+:orphan:`
`2`	`2`
`3`	`3`	`Client Class`
`4`	`4`	`------------`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-`FAQ list :back: <readme.md>`__
	`1`	`+:orphan:`
`2`	`2`
`3`	`3`	`I am getting "espcomm\_sync failed" error when trying to upload my ESP. How to resolve this issue?`
`4`	`4`	`--------------------------------------------------------------------------------------------------`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`My ESP crashes running some code. How to troubleshoot it?`
`2`	`4`	`---------------------------------------------------------`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`This Arduino library doesn't work on ESP. How do I make it working?`
`2`	`4`	`-------------------------------------------------------------------`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`How to resolve "Board generic (platform esp8266, package esp8266) is unknown" error?`
`2`	`4`	`------------------------------------------------------------------------------------`
`3`	`5`