cpython/Doc/howto/index.rst

69 lines
1.4 KiB
ReStructuredText
Raw Normal View History

2007-08-15 11:28:22 -03:00
***************
Python HOWTOs
***************
Python HOWTOs are documents that cover a specific topic in-depth.
Modeled on the Linux Documentation Project's HOWTO collection, this collection is an
2007-08-15 11:28:22 -03:00
effort to foster documentation that's more detailed than the
Python Library Reference.
.. toctree::
:maxdepth: 1
:hidden:
2007-08-15 11:28:22 -03:00
Devil merge! Merged revisions 66561,66564,66580,66610,66614,66618,66624-66625,66628-66629,66643,66645,66660-66665 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r66561 | benjamin.peterson | 2008-09-22 17:13:29 -0500 (Mon, 22 Sep 2008) | 1 line clean up docs for platform's linux_distribution and dist functions ........ r66564 | benjamin.peterson | 2008-09-23 08:32:46 -0500 (Tue, 23 Sep 2008) | 1 line mention how to override boolean evaluation ........ r66580 | georg.brandl | 2008-09-24 04:47:55 -0500 (Wed, 24 Sep 2008) | 2 lines Indentation normalization. ........ r66610 | andrew.kuchling | 2008-09-24 12:27:55 -0500 (Wed, 24 Sep 2008) | 1 line Improve wording ........ r66614 | benjamin.peterson | 2008-09-24 17:11:59 -0500 (Wed, 24 Sep 2008) | 4 lines #3950 fix missing scale factors in turtle.py reviewers: Georg, Benjamin ........ r66618 | benjamin.peterson | 2008-09-25 15:35:45 -0500 (Thu, 25 Sep 2008) | 1 line add a NEWs entry for r66614 ........ r66624 | raymond.hettinger | 2008-09-25 18:31:52 -0500 (Thu, 25 Sep 2008) | 1 line Fix namedtuple bug reported by Glenn Linderman. Template did not form correctly if the field names were input in Unicode. ........ r66625 | benjamin.peterson | 2008-09-25 21:58:36 -0500 (Thu, 25 Sep 2008) | 1 line add the beginnings of a C-API 2 -> 3 porting guide ........ r66628 | benjamin.peterson | 2008-09-26 15:52:06 -0500 (Fri, 26 Sep 2008) | 1 line add an 'other options' section ........ r66629 | georg.brandl | 2008-09-26 16:15:21 -0500 (Fri, 26 Sep 2008) | 2 lines typos. ........ r66643 | andrew.kuchling | 2008-09-27 09:12:33 -0500 (Sat, 27 Sep 2008) | 1 line Add a last bunch of items ........ r66645 | benjamin.peterson | 2008-09-27 11:23:55 -0500 (Sat, 27 Sep 2008) | 1 line 2to3's api should be considered unstable ........ r66660 | andrew.kuchling | 2008-09-27 17:54:08 -0500 (Sat, 27 Sep 2008) | 1 line #3510: future-proof text ........ r66661 | benjamin.peterson | 2008-09-27 18:28:43 -0500 (Sat, 27 Sep 2008) | 1 line clarify a few things ........ r66662 | andrew.kuchling | 2008-09-27 19:15:27 -0500 (Sat, 27 Sep 2008) | 1 line #1579477: mention necessity to flush output before exec'ing ........ r66663 | andrew.kuchling | 2008-09-27 20:08:47 -0500 (Sat, 27 Sep 2008) | 1 line #1415508: Document two functions ........ r66664 | benjamin.peterson | 2008-09-27 20:51:36 -0500 (Sat, 27 Sep 2008) | 1 line better grammar ........ r66665 | benjamin.peterson | 2008-09-27 20:53:29 -0500 (Sat, 27 Sep 2008) | 1 line note the 2to3 -d could be useful for other refactoring ........
2008-09-27 23:06:32 -03:00
cporting.rst
2007-08-15 11:28:22 -03:00
curses.rst
2010-05-19 18:39:51 -03:00
descriptor.rst
gh-89480: Document the gdb helpers (GH-115657) Content adapted from https://devguide.python.org/development-tools/gdb/# and https://wiki.python.org/moin/DebuggingWithGdb. The original content on the Wiki page came from gdb debug help used by the Launchpad (https://launchpad.net/) team. Thanks to Anatoly Techtonik and user `rmf` for substantial improvements to the Wiki page. The history of the Devguide page follows (with log entries expanded for major content contributions): Hugo van Kemenade, Sat Dec 30 21:22:04 2023 +0200 Hugo van Kemenade, Fri Dec 8 12:04:32 2023 +0200 Erlend E. Aasland & Hugo van Kemenade, Tue Aug 8 22:05:34 2023 +0200 Satish Mishra, Sat Feb 11 13:54:57 2023 +0530 Hugo van Kemenade, Fri Dec 23 17:33:33 2022 +0200 Skip Montanaro, Hugo, Erlend, & Ezio, Fri Nov 4 05:04:23 2022 -0500 Add a GDB tips section to Advanced Tools (#977) Adam Turner, Wed Jun 15 21:19:23 2022 +0100 Adam Turner, Tue Jun 14 11:12:26 2022 +0100 Suriyaa, Fri Jun 8 19:39:23 2018 +0200 Jeff Allen, Tue Oct 24 18:12:53 2017 +0100 Jeff Allen, Fri Oct 13 13:43:43 2017 +0100 Mariatta, Wed Jan 4 09:14:55 2017 -0800 Carol Willing, Mon Sep 26 14:50:54 2016 -0700 Zachary Ware, Thu Jul 21 10:42:23 2016 -0500 Georg Brandl, Mon Nov 3 11:28:19 2014 +0100 Add instruction how to activate python-gdb.py Georg Brandl, Sun Mar 9 10:32:01 2014 +0100 Georg Brandl, Tue Apr 3 09:12:53 2012 +0200 Georg Brandl, Sat Mar 5 17:32:35 2011 +0100 Dave Malcolm, Fri Jan 21 12:34:09 2011 -0500 Add documentation on the gdb extension commands provided in libpython.py I adapted this from documentation I wrote for the Fedora wiki: https://fedoraproject.org/wiki/Features/EasierPythonDebugging#New_gdb_commands reformatting it as rst, and making other minor changes Brett Cannon, Thu Jan 20 15:16:52 2011 -0800 Dave Malcolm, Thu Jan 20 16:17:23 2011 -0500 Add some notes on the gdb pretty-printer hooks Antoine Pitrou, Thu Jan 20 21:17:49 2011 +0100 Give an example backtrace Antoine Pitrou, Thu Jan 20 21:03:06 2011 +0100 Expand explanations about gdb support Brett Cannon, Thu Jan 20 11:33:36 2011 -0800 Tweak the gdb support title to fit in better with the devguide. Brett Cannon, Mon Jan 17 21:12:54 2011 +0000 Short README on gdb support. Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com>
2024-02-23 12:13:45 -04:00
gdb_helpers.rst
enum.rst
2007-08-15 11:28:22 -03:00
functional.rst
2010-12-19 08:56:57 -04:00
logging.rst
logging-cookbook.rst
2007-08-15 11:28:22 -03:00
regex.rst
sockets.rst
2010-09-01 06:15:42 -03:00
sorting.rst
2007-08-15 11:28:22 -03:00
unicode.rst
urllib2.rst
argparse.rst
ipaddress.rst
instrumentation.rst
perf_profiling.rst
annotations.rst
isolating-extensions.rst
timerfd.rst
mro.rst
free-threading-python.rst
free-threading-extensions.rst
2007-08-15 11:28:22 -03:00
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-python-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`