diff options
| author | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2022-06-01 07:29:13 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-01 07:29:13 (GMT) |
| commit | 132e563703ed634312e54c04a9b1636f8b0e2923 (patch) | |
| tree | 37c25b021f49ed97b0525ce2678a557a99f330e7 /Doc/howto | |
| parent | 5247389369ac3da35c44f7c0d8f4facc0300883a (diff) | |
| download | cpython-132e563703ed634312e54c04a9b1636f8b0e2923.zip cpython-132e563703ed634312e54c04a9b1636f8b0e2923.tar.gz cpython-132e563703ed634312e54c04a9b1636f8b0e2923.tar.bz2 | |
[doc] Improve discoverability of links between logging documents. (GH-93405)
Diffstat (limited to 'Doc/howto')
| -rw-r--r-- | Doc/howto/logging-cookbook.rst | 23 | ||||
| -rw-r--r-- | Doc/howto/logging.rst | 8 |
2 files changed, 30 insertions, 1 deletions
diff --git a/Doc/howto/logging-cookbook.rst b/Doc/howto/logging-cookbook.rst index 7042792..2b5eb8f 100644 --- a/Doc/howto/logging-cookbook.rst +++ b/Doc/howto/logging-cookbook.rst @@ -7,7 +7,8 @@ Logging Cookbook :Author: Vinay Sajip <vinay_sajip at red-dove dot com> 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 @@ -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 areas within your application (generally modules, but occasionally slightly 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>` diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst index cc4e278..f024430 100644 --- a/Doc/howto/logging.rst +++ b/Doc/howto/logging.rst @@ -8,6 +8,9 @@ Logging HOWTO .. 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 ---------------------- @@ -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 take up any memory. +.. _tutorial-ref-links: + +Other resources +--------------- + .. seealso:: Module :mod:`logging` |