Skip to content

Commit 9c7e30b

Browse files
authored
Modify docs to comment out unpopulated toctrees (#987)
Prior to this, the toctree directives pointed at numerous planned but unpopulated docs. The result is a mostly empty site with the real content buried. To revert without discarding work, the toctrees which list empty files are commented out, and new tables of contents are added to link to `libraries` and `stubs` (the existing, populated sections). Stub docs are left in place, producing sphinx warnings about unlinked docs. These are expected. The link to the typing module docs has been restored, now in a dedicated section.
1 parent 80cfad0 commit 9c7e30b

File tree

2 files changed

+24
-13
lines changed

2 files changed

+24
-13
lines changed

docs/index.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
*************************
22
Static Typing with Python
33
*************************
4-
5-
.. toctree::
6-
:maxdepth: 2
7-
:caption: Contents:
8-
9-
source/introduction
4+
..
5+
.. .. toctree::
6+
.. :maxdepth: 2
7+
.. :caption: Contents:
8+
..
9+
.. source/introduction
1010
1111
.. toctree::
1212
:maxdepth: 3
@@ -20,6 +20,10 @@ Indices and tables
2020
* :ref:`genindex`
2121
* :ref:`search`
2222

23+
Python Language Documentation
24+
=============================
25+
26+
* `typing Module Documentation <https://docs.python.org/3/library/typing.html>`_
2327

2428
Discussions and Support
2529
=======================

docs/source/reference.rst

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,17 @@ Type System Reference
66
:maxdepth: 2
77
:caption: Contents:
88

9-
basics
10-
type_system
11-
annotations
12-
inference
13-
type_compatibility
14-
dependencies
15-
faq
9+
libraries
10+
stubs
11+
12+
13+
.. The following pages are desired in a new TOC which will cover multiple
14+
.. topics. For now, they are not linked because the pages are empty.
15+
..
16+
.. basics
17+
.. type_system
18+
.. annotations
19+
.. inference
20+
.. type_compatibility
21+
.. dependencies
22+
.. faq

0 commit comments

Comments
 (0)