From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Date: Wed, 11 Dec 2024 06:58:37 +0000 (+0200)
Subject: [3.12] Update the documentation howto index page and group docs into 3 logical sectio... 
X-Git-Tag: v3.12.9~168
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=20c0c8cf3849e94ab75f95e760158c398de334f2;p=thirdparty%2FPython%2Fcpython.git

[3.12] Update the documentation howto index page and group docs into 3 logical sections (GH-119366) (#127811)

(cherry picked from commit a26d27e7ee512cd822b7a7ba075171152779ffdd)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
---

diff --git a/Doc/howto/enum.rst b/Doc/howto/enum.rst
index 9b6bb6137499..3743e68192f7 100644
--- a/Doc/howto/enum.rst
+++ b/Doc/howto/enum.rst
@@ -1,3 +1,5 @@
+.. _enum-howto:
+
 ==========
 Enum HOWTO
 ==========
diff --git a/Doc/howto/functional.rst b/Doc/howto/functional.rst
index b0f9d22d74f0..1f0608fb0fc5 100644
--- a/Doc/howto/functional.rst
+++ b/Doc/howto/functional.rst
@@ -1,3 +1,5 @@
+.. _functional-howto:
+
 ********************************
   Functional Programming HOWTO
 ********************************
diff --git a/Doc/howto/index.rst b/Doc/howto/index.rst
index 9c8458f2bb68..98364aaf0278 100644
--- a/Doc/howto/index.rst
+++ b/Doc/howto/index.rst
@@ -2,16 +2,14 @@
  Python HOWTOs
 ***************
 
-Python HOWTOs are documents that cover a single, specific topic,
-and attempt to cover it fairly completely. Modelled on the Linux
-Documentation Project's HOWTO collection, this collection is an
+Python HOWTOs are documents that cover a specific topic in-depth.
+Modeled on the Linux Documentation Project's HOWTO collection, this collection is an
 effort to foster documentation that's more detailed than the
 Python Library Reference.
 
-Currently, the HOWTOs are:
-
 .. toctree::
    :maxdepth: 1
+   :hidden:
 
    cporting.rst
    curses.rst
@@ -33,3 +31,32 @@ Currently, the HOWTOs are:
    annotations.rst
    isolating-extensions.rst
    mro.rst
+
+General:
+
+* :ref:`annotations-howto`
+* :ref:`argparse-tutorial`
+* :ref:`descriptorhowto`
+* :ref:`enum-howto`
+* :ref:`functional-howto`
+* :ref:`ipaddress-howto`
+* :ref:`logging-howto`
+* :ref:`logging-cookbook`
+* :ref:`regex-howto`
+* :ref:`sortinghowto`
+* :ref:`unicode-howto`
+* :ref:`urllib-howto`
+
+Advanced development:
+
+* :ref:`curses-howto`
+* :ref:`isolating-extensions-howto`
+* :ref:`python_2.3_mro`
+* :ref:`socket-howto`
+* :ref:`cporting-howto`
+
+Debugging and profiling:
+
+* :ref:`gdb`
+* :ref:`instrumentation`
+* :ref:`perf_profiling`
diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst
index 5a392f94da4f..597de77a828e 100644
--- a/Doc/howto/logging.rst
+++ b/Doc/howto/logging.rst
@@ -1,3 +1,5 @@
+.. _logging-howto:
+
 =============
 Logging HOWTO
 =============