Skip to content

Update the documentation howto index page and group docs into 3 logical sections #119366

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.

Sign up for GitHub

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 5 commits into from
Jun 17, 2024
Merged

Update the documentation howto index page and group docs into 3 logical sections #119366

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
125adbe
Break up HOWTO contents into separate section
willingc May 21, 2024
ef9638d
Update the HOWTO index page to group documents into sections
willingc May 21, 2024
fcecb4b
Merge branch 'main' into howto-order
willingc May 21, 2024
74caa71
Apply Ned's simplification
willingc May 22, 2024
d25ed74
Add cporting-howto back
encukou Jun 14, 2024
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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _functional-howto:

********************************
Functional Programming HOWTO
********************************
Expand Down
36 changes: 31 additions & 5 deletions Doc/howto/index.rst
View file
Open in desktop
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 @@ -35,3 +33,31 @@ Currently, the HOWTOs are:
timerfd.rst
mro.rst

General:

* :ref:`Annotations Best Practices <annotations-howto>`
* :ref:`Argparse tutorial <argparse-tutorial>`
* :ref:`Descriptor Guide <descriptorhowto>`
* :ref:`Enum HOWTO <enum-howto>`
* :ref:`Functional Programming HOWTO <functional-howto>`
* :ref:`An introduction to the ipaddress module <ipaddress-howto>`
* :ref:`Logging HOWTO <logging-howto>`
* :ref:`Logging Cookbook <logging-cookbook>`
* :ref:`Regular Expression HOWTO <regex-howto>`
* :ref:`Sorting Techniques <sortinghowto>`
* :ref:`Unicode HOWTO <unicode-howto>`
* :ref:`HOWTO Fetch Internet Resources Using The urllib Package <urllib-howto>`

Advanced development:

* :ref:`Curses Programming with Python <curses-howto>`
* :ref:`Isolating Extension Modules <isolating-extensions-howto>`
* :ref:`The Python 2.3 Method Resolution Order <python_2.3_mro>`
* :ref:`Socket Programming HOWTO <socket-howto>`
* :ref:`Timer file descriptor <timerfd-howto>`

Debugging and profiling:

* :ref:`Debugging C API extensions and CPython Internals with GDB <gdb>`
* :ref:`Instrumenting CPython with DTrace and SystemTap <instrumentation>`
* :ref:`Python support for the Linux perf profiler <perf_profiling>`
2 changes: 2 additions & 0 deletions Doc/howto/logging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _logging-howto:

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