Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion Doc/howto/logging-cookbook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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>`
8 changes: 8 additions & 0 deletions Doc/howto/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------

Expand Down Expand Up @@ -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`
Expand Down