Skip to content

Commit b88c484

Browse files
authored
Organize docs along diatxis categories. (#2898)
2 parents e3abce6 + fc30c69 commit b88c484

File tree

2 files changed

+36
-12
lines changed

2 files changed

+36
-12
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
# General --------------------------------------------------------------
1212

13+
master_doc = "index"
1314
default_role = "code"
1415
extensions = [
1516
"sphinx.ext.autodoc",

docs/index.rst

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,35 @@ You can get the library directly from PyPI::
6060
Documentation
6161
-------------
6262

63-
This part of the documentation guides you through all of the library's
64-
usage patterns.
65-
63+
Tutorials
64+
^^^^^^^^^^^^^
6665
.. toctree::
67-
:maxdepth: 2
66+
:maxdepth: 1
6867

69-
why
7068
quickstart
71-
entry-points
7269
virtualenv
70+
71+
How to Guides
72+
^^^^^^^^^^^^^
73+
.. toctree::
74+
:maxdepth: 1
75+
76+
entry-points
7377
setuptools
78+
79+
Conceptual Guides
80+
^^^^^^^^^^^^^^^^^^^
81+
.. toctree::
82+
:maxdepth: 1
83+
84+
why
85+
86+
General Reference
87+
^^^^^^^^^^^^^^^^^^^
88+
89+
.. toctree::
90+
:maxdepth: 1
91+
7492
parameters
7593
parameter-types
7694
options
@@ -91,21 +109,26 @@ usage patterns.
91109
wincmd
92110

93111
API Reference
94-
-------------
95-
96-
If you are looking for information on a specific function, class, or
97-
method, this part of the documentation is for you.
112+
^^^^^^^^^^^^^^^
98113

99114
.. toctree::
100115
:maxdepth: 2
101116

102117
api
103118

104-
Miscellaneous Pages
119+
About Project
105120
-------------------
106121

122+
* This documentation is structured according to `Diataxis <https://diataxis.fr/>`_
123+
124+
* `Version Policy <https://palletsprojects.com/versions>`_
125+
126+
* `Contributing <https://palletsprojects.com/contributing/>`_
127+
128+
* `Donate <https://palletsprojects.com/donate>`_
129+
107130
.. toctree::
108-
:maxdepth: 2
131+
:maxdepth: 1
109132

110133
contrib
111134
license

0 commit comments

Comments
 (0)