mirror of https://github.com/python/cpython
Update the documentation howto index page and group docs into 3 logical sections (GH-119366)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
This commit is contained in:
parent
4bf17c381f
commit
a26d27e7ee
|
@ -1,3 +1,5 @@
|
||||||
|
.. _enum-howto:
|
||||||
|
|
||||||
==========
|
==========
|
||||||
Enum HOWTO
|
Enum HOWTO
|
||||||
==========
|
==========
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _functional-howto:
|
||||||
|
|
||||||
********************************
|
********************************
|
||||||
Functional Programming HOWTO
|
Functional Programming HOWTO
|
||||||
********************************
|
********************************
|
||||||
|
|
|
@ -2,16 +2,14 @@
|
||||||
Python HOWTOs
|
Python HOWTOs
|
||||||
***************
|
***************
|
||||||
|
|
||||||
Python HOWTOs are documents that cover a single, specific topic,
|
Python HOWTOs are documents that cover a specific topic in-depth.
|
||||||
and attempt to cover it fairly completely. Modelled on the Linux
|
Modeled on the Linux Documentation Project's HOWTO collection, this collection is an
|
||||||
Documentation Project's HOWTO collection, this collection is an
|
|
||||||
effort to foster documentation that's more detailed than the
|
effort to foster documentation that's more detailed than the
|
||||||
Python Library Reference.
|
Python Library Reference.
|
||||||
|
|
||||||
Currently, the HOWTOs are:
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
:hidden:
|
||||||
|
|
||||||
cporting.rst
|
cporting.rst
|
||||||
curses.rst
|
curses.rst
|
||||||
|
@ -35,3 +33,32 @@ Currently, the HOWTOs are:
|
||||||
timerfd.rst
|
timerfd.rst
|
||||||
mro.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`
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _logging-howto:
|
||||||
|
|
||||||
=============
|
=============
|
||||||
Logging HOWTO
|
Logging HOWTO
|
||||||
=============
|
=============
|
||||||
|
|
Loading…
Reference in New Issue