Skip to content

Commit ae26334

Browse files
authored
Improve TOC structure (#988)
* Add section headers to the toc tree * Add a "Guides" section and put the libraries document there * Move the link to the typing documentation into the "Reference" section Cf. #845
1 parent 9c7e30b commit ae26334

File tree

3 files changed

+25
-10
lines changed

3 files changed

+25
-10
lines changed

docs/index.rst

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,37 @@
11
*************************
22
Static Typing with Python
33
*************************
4+
5+
.. Introduction
6+
.. ============
47
..
58
.. .. toctree::
69
.. :maxdepth: 2
7-
.. :caption: Contents:
810
..
911
.. source/introduction
1012
13+
Guides
14+
======
15+
1116
.. toctree::
12-
:maxdepth: 3
17+
:maxdepth: 2
1318

14-
source/reference
19+
source/guides
1520

21+
Reference
22+
=========
23+
24+
.. toctree::
25+
:maxdepth: 2
26+
27+
source/reference
1628

1729
Indices and tables
1830
==================
1931

2032
* :ref:`genindex`
2133
* :ref:`search`
2234

23-
Python Language Documentation
24-
=============================
25-
26-
* `typing Module Documentation <https://docs.python.org/3/library/typing.html>`_
27-
2835
Discussions and Support
2936
=======================
3037

docs/source/guides.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
******************
2+
Type System Guides
3+
******************
4+
5+
.. toctree::
6+
:maxdepth: 2
7+
:caption: Contents:
8+
9+
libraries

docs/source/reference.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ Type System Reference
66
:maxdepth: 2
77
:caption: Contents:
88

9-
libraries
109
stubs
11-
10+
typing Module Documentation <https://docs.python.org/3/library/typing.html>
1211

1312
.. The following pages are desired in a new TOC which will cover multiple
1413
.. topics. For now, they are not linked because the pages are empty.

0 commit comments

Comments
 (0)