diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-06-20 10:24:14 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-20 10:24:14 (GMT) |
| commit | d0a5e40f01c9e05100fb2548613805653fb71864 (patch) | |
| tree | 3284317384916637f7a060f2fca0edb5c17544ab | |
| parent | 8cfd005b6df2f1d07c0dd00450009a41796a2718 (diff) | |
| download | cpython-d0a5e40f01c9e05100fb2548613805653fb71864.zip cpython-d0a5e40f01c9e05100fb2548613805653fb71864.tar.gz cpython-d0a5e40f01c9e05100fb2548613805653fb71864.tar.bz2 | |
[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 a26d27e7ee512cd822b7a7ba075171152779ffdd)
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 45d5cab533a607716b2b41134839a59facf309cd)
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
| -rw-r--r-- | Doc/howto/enum.rst | 2 | ||||
| -rw-r--r-- | Doc/howto/functional.rst | 2 | ||||
| -rw-r--r-- | Doc/howto/index.rst | 38 | ||||
| -rw-r--r-- | Doc/howto/logging.rst | 2 |
4 files changed, 39 insertions, 5 deletions
diff --git a/Doc/howto/enum.rst b/Doc/howto/enum.rst index 0b122ae..18e13fc 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 b0f9d22..1f0608f 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 a1f17ec..a882f17 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 @@ -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 index ab758a8..cf5b693 100644 --- a/Doc/howto/logging.rst +++ b/Doc/howto/logging.rst @@ -1,3 +1,5 @@ +.. _logging-howto: + ============= Logging HOWTO ============= |