From a26d27e7ee512cd822b7a7ba075171152779ffdd Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 17 Jun 2024 07:37:33 -0700 Subject: [PATCH] Update the documentation howto index page and group docs into 3 logical sections (GH-119366) Co-authored-by: Ned Batchelder --- Doc/howto/enum.rst | 2 ++ Doc/howto/functional.rst | 2 ++ Doc/howto/index.rst | 37 ++++++++++++++++++++++++++++++++----- Doc/howto/logging.rst | 2 ++ 4 files changed, 38 insertions(+), 5 deletions(-) diff --git a/Doc/howto/enum.rst b/Doc/howto/enum.rst index 30be15230fc..748ec5b2436 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 b0f9d22d74f..1f0608fb0fc 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 065071e39a0..71880079f3f 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 @@ -35,3 +33,32 @@ Currently, the HOWTOs are: timerfd.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:`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 index ab758a885b3..cf5b693d8e3 100644 --- a/Doc/howto/logging.rst +++ b/Doc/howto/logging.rst @@ -1,3 +1,5 @@ +.. _logging-howto: + ============= Logging HOWTO =============