mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-17 09:30:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[doc] Improve discoverability of links between logging documents. (GH-93405)

Browse source
This commit is contained in:
Vinay Sajip 2022-06-01 08:29:13 +01:00 • committed by GitHub
parent 5247389369
commit 132e563703
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
Doc/howto/logging-cookbook.rst
View file

@ -7,7 +7,8 @@ Logging Cookbook
:Author: Vinay Sajip <vinay_sajip at red-dove dot com> :Author: Vinay Sajip <vinay_sajip at red-dove dot com>
This page contains a number of recipes related to logging, which have been found This page contains a number of recipes related to logging, which have been found
useful in the past. useful in the past. For links to tutorial and reference information, please see
:ref:`cookbook-ref-links`.
.. currentmodule:: logging .. currentmodule:: logging
@ -3075,3 +3076,23 @@ the :ref:`existing mechanisms <context-info>` for passing contextual
information into your logs and restrict the loggers created to those describing information into your logs and restrict the loggers created to those describing
areas within your application (generally modules, but occasionally slightly areas within your application (generally modules, but occasionally slightly
more fine-grained than that). more fine-grained than that).
.. _cookbook-ref-links:
Other resources
---------------
.. seealso::
Module :mod:`logging`
API reference for the logging module.
Module :mod:`logging.config`
Configuration API for the logging module.
Module :mod:`logging.handlers`
Useful handlers included with the logging module.
:ref:`Basic Tutorial <logging-basic-tutorial>`
:ref:`Advanced Tutorial <logging-advanced-tutorial>`

8
Doc/howto/logging.rst
View file

@ -8,6 +8,9 @@ Logging HOWTO
.. currentmodule:: logging .. currentmodule:: logging
This page contains tutorial information. For links to reference information and a
logging cookbook, please see :ref:`tutorial-ref-links`.
Basic Logging Tutorial Basic Logging Tutorial
---------------------- ----------------------
@ -1109,6 +1112,11 @@ Also note that the core logging module only includes the basic handlers. If
you don't import :mod:`logging.handlers` and :mod:`logging.config`, they won't you don't import :mod:`logging.handlers` and :mod:`logging.config`, they won't
take up any memory. take up any memory.
.. _tutorial-ref-links:
Other resources
---------------
.. seealso:: .. seealso::
Module :mod:`logging` Module :mod:`logging`