Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 38cb0b9

Browse filesBrowse files
willingcnedbat
authored and
miss-islington
committed
Update the documentation howto index page and group docs into 3 logical sections (pythonGH-119366)
(cherry picked from commit a26d27e) Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
1 parent 03b89e3 commit 38cb0b9
Copy full SHA for 38cb0b9

File tree

Expand file treeCollapse file tree

4 files changed

+38
-5
lines changed
Filter options
Expand file treeCollapse file tree

4 files changed

+38
-5
lines changed

‎Doc/howto/enum.rst

Copy file name to clipboardExpand all lines: Doc/howto/enum.rst
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _enum-howto:
2+
13
==========
24
Enum HOWTO
35
==========

‎Doc/howto/functional.rst

Copy file name to clipboardExpand all lines: Doc/howto/functional.rst
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _functional-howto:
2+
13
********************************
24
Functional Programming HOWTO
35
********************************

‎Doc/howto/index.rst

Copy file name to clipboardExpand all lines: Doc/howto/index.rst
+32-5Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22
Python HOWTOs
33
***************
44

5-
Python HOWTOs are documents that cover a single, specific topic,
6-
and attempt to cover it fairly completely. Modelled on the Linux
7-
Documentation Project's HOWTO collection, this collection is an
5+
Python HOWTOs are documents that cover a specific topic in-depth.
6+
Modeled on the Linux Documentation Project's HOWTO collection, this collection is an
87
effort to foster documentation that's more detailed than the
98
Python Library Reference.
109

11-
Currently, the HOWTOs are:
12-
1310
.. toctree::
1411
:maxdepth: 1
12+
:hidden:
1513

1614
cporting.rst
1715
curses.rst
@@ -35,3 +33,32 @@ Currently, the HOWTOs are:
3533
timerfd.rst
3634
mro.rst
3735

36+
General:
37+
38+
* :ref:`annotations-howto`
39+
* :ref:`argparse-tutorial`
40+
* :ref:`descriptorhowto`
41+
* :ref:`enum-howto`
42+
* :ref:`functional-howto`
43+
* :ref:`ipaddress-howto`
44+
* :ref:`logging-howto`
45+
* :ref:`logging-cookbook`
46+
* :ref:`regex-howto`
47+
* :ref:`sortinghowto`
48+
* :ref:`unicode-howto`
49+
* :ref:`urllib-howto`
50+
51+
Advanced development:
52+
53+
* :ref:`curses-howto`
54+
* :ref:`isolating-extensions-howto`
55+
* :ref:`python_2.3_mro`
56+
* :ref:`socket-howto`
57+
* :ref:`timerfd-howto`
58+
* :ref:`cporting-howto`
59+
60+
Debugging and profiling:
61+
62+
* :ref:`gdb`
63+
* :ref:`instrumentation`
64+
* :ref:`perf_profiling`

‎Doc/howto/logging.rst

Copy file name to clipboardExpand all lines: Doc/howto/logging.rst
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _logging-howto:
2+
13
=============
24
Logging HOWTO
35
=============

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.