From 748f493f334ed9e39598374c82ec12960bb85cbf Mon Sep 17 00:00:00 2001
From: Paul Sokolovsky <pfalcon@users.sourceforge.net>
Date: Tue, 27 Jun 2017 00:34:10 +0300
Subject: [PATCH] docs: Move all ports docs to the single ToC.

Previously, only "selected chapters" were shown in left-pane ToC (of
Read The Docs theme). These chapters were selected out of order. The
rest of chapters were hidden beyond "Documentation Contents" pseudo-
chapter. This arguably led only to confusion, as many people probably
never tried to open that pseudo-chapter, and those who did, were
confused. Such organization is even worse for PDF output, causing
chapters go in mix-mashed order.

So, instead move to single clean ToC. This will allow readers of HTML
to have access to any doc content at their fingertips (and straight
before their eyes), and will allow to finally have clean PDF docs.
---
 docs/esp8266_contents.rst | 12 ------------
 docs/esp8266_index.rst    |  4 +++-
 docs/pyboard_contents.rst | 14 --------------
 docs/pyboard_index.rst    |  4 ++--
 docs/topindex.html        |  2 +-
 docs/unix_contents.rst    |  9 ---------
 docs/unix_index.rst       |  2 +-
 docs/wipy_contents.rst    | 12 ------------
 docs/wipy_index.rst       |  2 +-
 9 files changed, 8 insertions(+), 53 deletions(-)
 delete mode 100644 docs/esp8266_contents.rst
 delete mode 100644 docs/pyboard_contents.rst
 delete mode 100644 docs/unix_contents.rst
 delete mode 100644 docs/wipy_contents.rst

diff --git a/docs/esp8266_contents.rst b/docs/esp8266_contents.rst
deleted file mode 100644
index 7c35460bd..000000000
--- a/docs/esp8266_contents.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-MicroPython documentation contents
-==================================
-
-.. toctree::
-
-    esp8266/quickref.rst
-    esp8266/general.rst
-    esp8266/tutorial/index.rst
-    library/index.rst
-    reference/index.rst
-    genrst/index.rst
-    license.rst
diff --git a/docs/esp8266_index.rst b/docs/esp8266_index.rst
index 8654c43aa..d33234897 100644
--- a/docs/esp8266_index.rst
+++ b/docs/esp8266_index.rst
@@ -4,10 +4,12 @@ MicroPython documentation and references
 .. toctree::
 
     esp8266/quickref.rst
+    esp8266/general.rst
+    esp8266/tutorial/index.rst
     library/index.rst
+    reference/index.rst
     genrst/index.rst
     license.rst
-    esp8266_contents.rst
 
 Indices and tables
 ==================
diff --git a/docs/pyboard_contents.rst b/docs/pyboard_contents.rst
deleted file mode 100644
index 658dd366f..000000000
--- a/docs/pyboard_contents.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-MicroPython documentation contents
-==================================
-
-.. toctree::
-
-    pyboard/quickref.rst
-    pyboard/general.rst
-    pyboard/tutorial/index.rst
-    library/index.rst
-    reference/index.rst
-    pyboard/hardware/index.rst
-    genrst/index.rst
-    license.rst
-
diff --git a/docs/pyboard_index.rst b/docs/pyboard_index.rst
index 4caa4cc88..ea82f89d6 100644
--- a/docs/pyboard_index.rst
+++ b/docs/pyboard_index.rst
@@ -6,11 +6,11 @@ MicroPython documentation and references
     pyboard/quickref.rst
     pyboard/general.rst
     pyboard/tutorial/index.rst
-    library/index.rst
     pyboard/hardware/index.rst
+    library/index.rst
+    reference/index.rst
     genrst/index.rst
     license.rst
-    pyboard_contents.rst
 
 Indices and tables
 ==================
diff --git a/docs/topindex.html b/docs/topindex.html
index f32f3cea6..5e4cc2b40 100644
--- a/docs/topindex.html
+++ b/docs/topindex.html
@@ -88,7 +88,7 @@
     </td>
     <td width="40%" style="padding-left:2em;">
       <p class="biglink">
-        <a class="biglink" href="{{ pathto(port + "_contents") }}">Table of contents</a><br/>
+        <a class="biglink" href="{{ pathto(port + "_index") }}">Table of contents</a><br/>
         <span class="linkdescr">a list of all sections and subsections</span>
       </p>
     </td></tr>
diff --git a/docs/unix_contents.rst b/docs/unix_contents.rst
deleted file mode 100644
index 8c5a586b2..000000000
--- a/docs/unix_contents.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-MicroPython documentation contents
-==================================
-
-.. toctree::
-
-    library/index.rst
-    reference/index.rst
-    genrst/index.rst
-    license.rst
diff --git a/docs/unix_index.rst b/docs/unix_index.rst
index 7fa1753c2..07f245a30 100644
--- a/docs/unix_index.rst
+++ b/docs/unix_index.rst
@@ -4,9 +4,9 @@ MicroPython documentation and references
 .. toctree::
 
     library/index.rst
+    reference/index.rst
     genrst/index.rst
     license.rst
-    unix_contents.rst
 
 Indices and tables
 ==================
diff --git a/docs/wipy_contents.rst b/docs/wipy_contents.rst
deleted file mode 100644
index 0e50a7c6e..000000000
--- a/docs/wipy_contents.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-MicroPython documentation contents
-==================================
-
-.. toctree::
-
-    wipy/quickref.rst
-    wipy/general.rst
-    wipy/tutorial/index.rst
-    library/index.rst
-    reference/index.rst
-    genrst/index.rst
-    license.rst
diff --git a/docs/wipy_index.rst b/docs/wipy_index.rst
index a390aecb1..7edba8f54 100644
--- a/docs/wipy_index.rst
+++ b/docs/wipy_index.rst
@@ -7,9 +7,9 @@ MicroPython documentation and references
     wipy/general.rst
     wipy/tutorial/index.rst
     library/index.rst
+    reference/index.rst
     genrst/index.rst
     license.rst
-    wipy_contents.rst
 
 Indices and tables
 ==================
-- 
GitLab