diff options
| author | Stephen Rosen <sirosen@globus.org> | 2021-12-22 05:40:33 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-22 11:40:33 +0100 |
| commit | 9c7e30be0f71ff542ba3fa039fad820236e91d6e (patch) | |
| tree | 4786b0242db147f1bb8e6b70bd78be45ccd82705 | |
| parent | 80cfad0255d2a4b12690aa9f76299d755b51b4e2 (diff) | |
| download | typing-9c7e30be0f71ff542ba3fa039fad820236e91d6e.tar.gz | |
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.
| -rw-r--r-- | docs/index.rst | 16 | ||||
| -rw-r--r-- | docs/source/reference.rst | 21 |
2 files changed, 24 insertions, 13 deletions
diff --git a/docs/index.rst b/docs/index.rst index ed97870..e5cd9ad 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,12 @@ ************************* Static Typing with Python ************************* - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - source/introduction +.. +.. .. toctree:: +.. :maxdepth: 2 +.. :caption: Contents: +.. +.. source/introduction .. toctree:: :maxdepth: 3 @@ -20,6 +20,10 @@ Indices and tables * :ref:`genindex` * :ref:`search` +Python Language Documentation +============================= + +* `typing Module Documentation <https://docs.python.org/3/library/typing.html>`_ Discussions and Support ======================= diff --git a/docs/source/reference.rst b/docs/source/reference.rst index a5f321e..4fbccec 100644 --- a/docs/source/reference.rst +++ b/docs/source/reference.rst @@ -6,10 +6,17 @@ Type System Reference :maxdepth: 2 :caption: Contents: - basics - type_system - annotations - inference - type_compatibility - dependencies - faq + libraries + stubs + + +.. The following pages are desired in a new TOC which will cover multiple +.. topics. For now, they are not linked because the pages are empty. +.. +.. basics +.. type_system +.. annotations +.. inference +.. type_compatibility +.. dependencies +.. faq |