Skip to content

Commit 53c0526

Browse files
committed
Table of Content improvements
* Remove extra top levels from main ToC. * Don't include sub-chapters of the specification in the main ToC. * Reduce the ToC level by one on the guides index.
1 parent 2d88da2 commit 53c0526

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

docs/guides/index.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1+
:orphan:
2+
13
******************
24
Type System Guides
35
******************
46

7+
..
8+
Keep in sync with docs/index.rst.
9+
510
.. toctree::
6-
:maxdepth: 2
11+
:maxdepth: 1
712
:caption: Contents:
813

914
libraries

docs/index.rst

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,33 @@ Static Typing with Python
55
Guides
66
======
77

8+
..
9+
Keep in sync with docs/guides/index.rst.
10+
811
.. toctree::
9-
:maxdepth: 2
12+
:maxdepth: 1
1013

11-
guides/index
14+
guides/libraries
15+
guides/writing_stubs
16+
guides/modernizing
17+
guides/unreachable
18+
guides/type_narrowing
19+
guides/typing_anti_pitch
1220

1321
Reference
1422
=========
1523

24+
..
25+
Keep in sync with docs/reference/index.rst.
26+
1627
.. toctree::
17-
:maxdepth: 2
28+
:maxdepth: 1
1829

19-
reference/index
30+
reference/generics
31+
reference/protocols
32+
reference/best_practices
33+
reference/quality
34+
typing Module Documentation <https://docs.python.org/3/library/typing.html>
2035

2136
.. seealso::
2237

@@ -27,7 +42,7 @@ Specification
2742
=============
2843

2944
.. toctree::
30-
:maxdepth: 2
45+
:maxdepth: 1
3146

3247
spec/index
3348

docs/reference/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1+
:orphan:
2+
13
*********************
24
Type System Reference
35
*********************
46

7+
..
8+
Keep in sync with docs/index.rst.
9+
510
.. toctree::
611
:maxdepth: 2
712
:caption: Contents:

0 commit comments

Comments
 (0)