Skip to content

Commit 20c0c8c

Browse files
hugovkwillingcnedbat
authored
[3.12] Update the documentation howto index page and group docs into 3 logical sections (GH-119366) (#127811)
(cherry picked from commit a26d27e) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Ned Batchelder <[email protected]>
1 parent 019e858 commit 20c0c8c

File tree

4 files changed

+38
-5
lines changed

4 files changed

+38
-5
lines changed

Doc/howto/enum.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _enum-howto:
2+
13
==========
24
Enum HOWTO
35
==========

Doc/howto/functional.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _functional-howto:
2+
13
********************************
24
Functional Programming HOWTO
35
********************************

Doc/howto/index.rst

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22
Python HOWTOs
33
***************
44

5-
Python HOWTOs are documents that cover a single, specific topic,
6-
and attempt to cover it fairly completely. Modelled on the Linux
7-
Documentation Project's HOWTO collection, this collection is an
5+
Python HOWTOs are documents that cover a specific topic in-depth.
6+
Modeled on the Linux Documentation Project's HOWTO collection, this collection is an
87
effort to foster documentation that's more detailed than the
98
Python Library Reference.
109

11-
Currently, the HOWTOs are:
12-
1310
.. toctree::
1411
:maxdepth: 1
12+
:hidden:
1513

1614
cporting.rst
1715
curses.rst
@@ -33,3 +31,32 @@ Currently, the HOWTOs are:
3331
annotations.rst
3432
isolating-extensions.rst
3533
mro.rst
34+
35+
General:
36+
37+
* :ref:`annotations-howto`
38+
* :ref:`argparse-tutorial`
39+
* :ref:`descriptorhowto`
40+
* :ref:`enum-howto`
41+
* :ref:`functional-howto`
42+
* :ref:`ipaddress-howto`
43+
* :ref:`logging-howto`
44+
* :ref:`logging-cookbook`
45+
* :ref:`regex-howto`
46+
* :ref:`sortinghowto`
47+
* :ref:`unicode-howto`
48+
* :ref:`urllib-howto`
49+
50+
Advanced development:
51+
52+
* :ref:`curses-howto`
53+
* :ref:`isolating-extensions-howto`
54+
* :ref:`python_2.3_mro`
55+
* :ref:`socket-howto`
56+
* :ref:`cporting-howto`
57+
58+
Debugging and profiling:
59+
60+
* :ref:`gdb`
61+
* :ref:`instrumentation`
62+
* :ref:`perf_profiling`

Doc/howto/logging.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _logging-howto:
2+
13
=============
24
Logging HOWTO
35
=============

0 commit comments

Comments
 (0)