]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Update the documentation howto index page and group docs into 3 logical sections...
authorCarol Willing <carolcode@willingconsulting.com>
Mon, 17 Jun 2024 14:37:33 +0000 (07:37 -0700)
committerGitHub <noreply@github.com>
Mon, 17 Jun 2024 14:37:33 +0000 (16:37 +0200)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Doc/howto/enum.rst
Doc/howto/functional.rst
Doc/howto/index.rst
Doc/howto/logging.rst

index 30be15230fc088eed430510795309f8012ac00ae..748ec5b24365d159d3f016cebe07b3bafa247f98 100644 (file)
@@ -1,3 +1,5 @@
+.. _enum-howto:
+
 ==========
 Enum HOWTO
 ==========
index b0f9d22d74f0e3111f3632504394772f404f0ce4..1f0608fb0fc53f02fd8c267f3ca87c14c3a7a803 100644 (file)
@@ -1,3 +1,5 @@
+.. _functional-howto:
+
 ********************************
   Functional Programming HOWTO
 ********************************
index 065071e39a06c58ad4451ff2a077df10413f139c..71880079f3ff0c7245078d5e2473d58555456ead 100644 (file)
@@ -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`
index ab758a885b355643cd925265a74fed7949b67f1d..cf5b693d8e38514abbc165f7c9fa1ebe5cc24708 100644 (file)
@@ -1,3 +1,5 @@
+.. _logging-howto:
+
 =============
 Logging HOWTO
 =============