https://github.com/python/cpython/commit/a26d27e7ee512cd822b7a7ba075171152779ffdd
commit: a26d27e7ee512cd822b7a7ba075171152779ffdd
branch: main
author: Carol Willing <carolc...@willingconsulting.com>
committer: encukou <encu...@gmail.com>
date: 2024-06-17T16:37:33+02:00
summary:
Update the documentation howto index page and group docs into 3 logical
sections (GH-119366)
Co-authored-by: Ned Batchelder <n...@nedbatchelder.com>
files:
M Doc/howto/enum.rst
M Doc/howto/functional.rst
M Doc/howto/index.rst
M Doc/howto/logging.rst
diff --git a/Doc/howto/enum.rst b/Doc/howto/enum.rst
index 30be15230fc088..748ec5b24365d1 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 b0f9d22d74f0e3..1f0608fb0fc53f 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 065071e39a06c5..71880079f3ff0c 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 ab758a885b3556..cf5b693d8e3851 100644
--- a/Doc/howto/logging.rst
+++ b/Doc/howto/logging.rst
@@ -1,3 +1,5 @@
+.. _logging-howto:
+
=============
Logging HOWTO
=============
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
