Skip to content

Commit d0a5e40

Browse files
miss-islingtonwillingcnedbat
authored
[3.13] Update the documentation howto index page and group docs into 3 logical sections (GH-119366, GH-120703) (GH-120646)
Update the documentation howto index page and group docs into 3 logical sections (GH-119366) (cherry picked from commit a26d27e) Includes a follow-up fix to properly merge GH-119877: * Add a link to free-threading HOWTO to the index (GH-120703) (cherry picked from commit 45d5cab) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Ned Batchelder <[email protected]>
1 parent 8cfd005 commit d0a5e40

File tree

4 files changed

+39
-5
lines changed

4 files changed

+39
-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: 33 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
@@ -36,3 +34,33 @@ Currently, the HOWTOs are:
3634
mro.rst
3735
free-threading-extensions.rst
3836

37+
General:
38+
39+
* :ref:`annotations-howto`
40+
* :ref:`argparse-tutorial`
41+
* :ref:`descriptorhowto`
42+
* :ref:`enum-howto`
43+
* :ref:`functional-howto`
44+
* :ref:`ipaddress-howto`
45+
* :ref:`logging-howto`
46+
* :ref:`logging-cookbook`
47+
* :ref:`regex-howto`
48+
* :ref:`sortinghowto`
49+
* :ref:`unicode-howto`
50+
* :ref:`urllib-howto`
51+
52+
Advanced development:
53+
54+
* :ref:`curses-howto`
55+
* :ref:`freethreading-extensions-howto`
56+
* :ref:`isolating-extensions-howto`
57+
* :ref:`python_2.3_mro`
58+
* :ref:`socket-howto`
59+
* :ref:`timerfd-howto`
60+
* :ref:`cporting-howto`
61+
62+
Debugging and profiling:
63+
64+
* :ref:`gdb`
65+
* :ref:`instrumentation`
66+
* :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)