[3.12] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) (#108680)

gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678)
(cherry picked from commit c7cef546319c51defa01236469b636b6978b99ab)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

diff --git a/Doc/howto/logging-cookbook.rst b/Doc/howto/logging-cookbook.rst
index 6ef252d709e73562d4d9606d7cade8290e72958a..772973edadd9d80e0a7fee8b6eb0fc5bac97213c 100644 (file)
--- a/Doc/howto/logging-cookbook.rst
+++ b/Doc/howto/logging-cookbook.rst
@@ -761,7 +761,7 @@ printed on the console; on the server side, you should see something like:
 
 Note that there are some security issues with pickle in some scenarios. If
 these affect you, you can use an alternative serialization scheme by overriding
-the :meth:`~handlers.SocketHandler.makePickle` method and implementing your
+the :meth:`~SocketHandler.makePickle` method and implementing your
 alternative there, as well as adapting the above script to use your alternative
 serialization.
 
@@ -835,6 +835,8 @@ To test these files, do the following in a POSIX environment:
 You may need to tweak the configuration files in the unlikely event that the
 configured ports clash with something else in your test environment.
 
+.. currentmodule:: logging
+
 .. _context-info:
 
 Adding contextual information to your logging output
@@ -1546,7 +1548,7 @@ Sometimes you want to let a log file grow to a certain size, then open a new
 file and log to that. You may want to keep a certain number of these files, and
 when that many files have been created, rotate the files so that the number of
 files and the size of the files both remain bounded. For this usage pattern, the
-logging package provides a :class:`~handlers.RotatingFileHandler`::
+logging package provides a :class:`RotatingFileHandler`::
 
    import glob
    import logging
@@ -1594,6 +1596,8 @@ and each time it reaches the size limit it is renamed with the suffix
 Obviously this example sets the log length much too small as an extreme
 example.  You would want to set *maxBytes* to an appropriate value.
 
+.. currentmodule:: logging
+
 .. _format-styles:
 
 Use of alternative formatting styles
@@ -1840,6 +1844,7 @@ However, it should be borne in mind that each link in the chain adds run-time
 overhead to all logging operations, and the technique should only be used when
 the use of a :class:`Filter` does not provide the desired result.
 
+.. currentmodule:: logging.handlers
 
 .. _zeromq-handlers:
 
@@ -1917,6 +1922,8 @@ of queues, for example a ZeroMQ 'subscribe' socket. Here's an example::
    :ref:`A more advanced logging tutorial <logging-advanced-tutorial>`
 
 
+.. currentmodule:: logging
+
 An example dictionary-based configuration
 -----------------------------------------
 
@@ -3918,8 +3925,8 @@ that in other languages such as Java and C#, loggers are often static class
 attributes. However, this pattern doesn't make sense in Python, where the
 module (and not the class) is the unit of software decomposition.
 
-Adding handlers other than :class:`NullHandler` to a logger in a library
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Adding handlers other than :class:`~logging.NullHandler` to a logger in a library
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Configuring logging by adding handlers, formatters and filters is the
 responsibility of the application developer, not the library developer. If you

diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 13fc06983dac46c879d11692c4046d286b7445b0..1ae878dbd6f790c4e8fa8adf18b790da473bac64 100644 (file)
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -28,7 +28,6 @@ Doc/glossary.rst
 Doc/howto/descriptor.rst
 Doc/howto/enum.rst
 Doc/howto/isolating-extensions.rst
-Doc/howto/logging-cookbook.rst
 Doc/howto/logging.rst
 Doc/howto/urllib2.rst
 Doc/library/2to3.rst