diff options
| author | Sebastian Rittau <srittau@rittau.biz> | 2021-12-22 17:00:56 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-22 08:00:56 -0800 |
| commit | ae2633465e647da3a99ebabd4b27e33b1b39036a (patch) | |
| tree | 294e4c1073a00da1264d8f50b9cc2baec5d0a495 | |
| parent | 9c7e30be0f71ff542ba3fa039fad820236e91d6e (diff) | |
| download | typing-ae2633465e647da3a99ebabd4b27e33b1b39036a.tar.gz | |
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
| -rw-r--r-- | docs/index.rst | 23 | ||||
| -rw-r--r-- | docs/source/guides.rst | 9 | ||||
| -rw-r--r-- | docs/source/reference.rst | 3 |
3 files changed, 25 insertions, 10 deletions
diff --git a/docs/index.rst b/docs/index.rst index e5cd9ad..7da222b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,18 +1,30 @@ ************************* Static Typing with Python ************************* + +.. Introduction +.. ============ .. .. .. toctree:: .. :maxdepth: 2 -.. :caption: Contents: .. .. source/introduction +Guides +====== + .. toctree:: - :maxdepth: 3 + :maxdepth: 2 - source/reference + source/guides +Reference +========= + +.. toctree:: + :maxdepth: 2 + + source/reference Indices and tables ================== @@ -20,11 +32,6 @@ 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/guides.rst b/docs/source/guides.rst new file mode 100644 index 0000000..9d435b7 --- /dev/null +++ b/docs/source/guides.rst @@ -0,0 +1,9 @@ +****************** +Type System Guides +****************** + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + libraries diff --git a/docs/source/reference.rst b/docs/source/reference.rst index 4fbccec..d18df3a 100644 --- a/docs/source/reference.rst +++ b/docs/source/reference.rst @@ -6,9 +6,8 @@ Type System Reference :maxdepth: 2 :caption: Contents: - libraries stubs - + typing Module Documentation <https://docs.python.org/3/library/typing.html> .. 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. |