Skip to content

Commit 748f493

Browse files
pfalconpfalcon
committed
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.
1 parent 683df1c commit 748f493

9 files changed

Lines changed: 8 additions & 53 deletions

‎docs/esp8266_contents.rst‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/esp8266_index.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ MicroPython documentation and references
44
.. toctree::
55

66
esp8266/quickref.rst
7+
esp8266/general.rst
8+
esp8266/tutorial/index.rst
79
library/index.rst
10+
reference/index.rst
811
genrst/index.rst
912
license.rst
10-
esp8266_contents.rst
1113

1214
Indices and tables
1315
==================

‎docs/pyboard_contents.rst‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎docs/pyboard_index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ MicroPython documentation and references
66
pyboard/quickref.rst
77
pyboard/general.rst
88
pyboard/tutorial/index.rst
9-
library/index.rst
109
pyboard/hardware/index.rst
10+
library/index.rst
11+
reference/index.rst
1112
genrst/index.rst
1213
license.rst
13-
pyboard_contents.rst
1414

1515
Indices and tables
1616
==================

‎docs/topindex.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ <h1>MicroPython documentation</h1>
8888
</td>
8989
<td width="40%" style="padding-left:2em;">
9090
<p class="biglink">
91-
<a class="biglink" href="{{ pathto(port + "_contents") }}">Table of contents</a><br/>
91+
<a class="biglink" href="{{ pathto(port + "_index") }}">Table of contents</a><br/>
9292
<span class="linkdescr">a list of all sections and subsections</span>
9393
</p>
9494
</td></tr>

‎docs/unix_contents.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎docs/unix_index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ MicroPython documentation and references
44
.. toctree::
55

66
library/index.rst
7+
reference/index.rst
78
genrst/index.rst
89
license.rst
9-
unix_contents.rst
1010

1111
Indices and tables
1212
==================

‎docs/wipy_contents.rst‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/wipy_index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ MicroPython documentation and references
77
wipy/general.rst
88
wipy/tutorial/index.rst
99
library/index.rst
10+
reference/index.rst
1011
genrst/index.rst
1112
license.rst
12-
wipy_contents.rst
1313

1414
Indices and tables
1515
==================

0 commit comments

Comments
 (0)