Skip to content

[3.13] Update the documentation howto index page and group docs into 3 logical sections (GH-119366) #120646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Doc/howto/enum.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _enum-howto:

==========
Enum HOWTO
==========
Expand Down
2 changes: 2 additions & 0 deletions Doc/howto/functional.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _functional-howto:

********************************
Functional Programming HOWTO
********************************
Expand Down
38 changes: 33 additions & 5 deletions Doc/howto/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`
2 changes: 2 additions & 0 deletions Doc/howto/logging.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _logging-howto:

=============
Logging HOWTO
=============
Expand Down
Loading