[Python-checkins] [doc] Improve discoverability of links between logging documents. (GH-93405)
vsajip
webhook-mailer at python.org
Wed Jun 1 03:29:21 EDT 2022
https://github.com/python/cpython/commit/132e563703ed634312e54c04a9b1636f8b0e2923
commit: 132e563703ed634312e54c04a9b1636f8b0e2923
branch: main
author: Vinay Sajip <vinay_sajip at yahoo.co.uk>
committer: vsajip <vinay_sajip at yahoo.co.uk>
date: 2022-06-01T08:29:13+01:00
summary:
[doc] Improve discoverability of links between logging documents. (GH-93405)
files:
M Doc/howto/logging-cookbook.rst
M Doc/howto/logging.rst
diff --git a/Doc/howto/logging-cookbook.rst b/Doc/howto/logging-cookbook.rst
index 704279240b357..2b5eb8ff320dd 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 cc4e278a7fe2e..f024430cedb0a 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`
More information about the Python-checkins
mailing list