[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 <carolcode@willingconsulting.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
python · Jun 20, 2024 · d0a5e40 · d0a5e40
1 parent 8cfd005
commit d0a5e40
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 5 deletions.
diff --git 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
@@ -1,3 +1,5 @@
+.. _functional-howto:
+
 ********************************
   Functional Programming HOWTO
 ********************************

diff --git 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
@@ -36,3 +34,33 @@ Currently, the HOWTOs are:
    mro.rst
    free-threading-extensions.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:`freethreading-extensions-howto`
+* :ref:`isolating-extensions-howto`
+* :ref:`python_2.3_mro`
+* :ref:`socket-howto`
+* :ref:`timerfd-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
@@ -1,3 +1,5 @@
+.. _logging-howto:
+
 =============
 Logging HOWTO
 =============