Skip to content

Commit 132e563

Browse files
authored
[doc] Improve discoverability of links between logging documents. (GH-93405)
1 parent 5247389 commit 132e563

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

Doc/howto/logging-cookbook.rst

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Logging Cookbook
77
:Author: Vinay Sajip <vinay_sajip at red-dove dot com>
88

99
This page contains a number of recipes related to logging, which have been found
10-
useful in the past.
10+
useful in the past. For links to tutorial and reference information, please see
11+
:ref:`cookbook-ref-links`.
1112

1213
.. currentmodule:: logging
1314

@@ -3075,3 +3076,23 @@ the :ref:`existing mechanisms <context-info>` for passing contextual
30753076
information into your logs and restrict the loggers created to those describing
30763077
areas within your application (generally modules, but occasionally slightly
30773078
more fine-grained than that).
3079+
3080+
.. _cookbook-ref-links:
3081+
3082+
Other resources
3083+
---------------
3084+
3085+
.. seealso::
3086+
3087+
Module :mod:`logging`
3088+
API reference for the logging module.
3089+
3090+
Module :mod:`logging.config`
3091+
Configuration API for the logging module.
3092+
3093+
Module :mod:`logging.handlers`
3094+
Useful handlers included with the logging module.
3095+
3096+
:ref:`Basic Tutorial <logging-basic-tutorial>`
3097+
3098+
:ref:`Advanced Tutorial <logging-advanced-tutorial>`

Doc/howto/logging.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Logging HOWTO
88

99
.. currentmodule:: logging
1010

11+
This page contains tutorial information. For links to reference information and a
12+
logging cookbook, please see :ref:`tutorial-ref-links`.
13+
1114
Basic Logging Tutorial
1215
----------------------
1316

@@ -1109,6 +1112,11 @@ Also note that the core logging module only includes the basic handlers. If
11091112
you don't import :mod:`logging.handlers` and :mod:`logging.config`, they won't
11101113
take up any memory.
11111114

1115+
.. _tutorial-ref-links:
1116+
1117+
Other resources
1118+
---------------
1119+
11121120
.. seealso::
11131121

11141122
Module :mod:`logging`

0 commit comments

Comments
 (0)