add logger module to sphinx

dill/__init__.py

@@ -30,13 +30,13 @@
     UnpicklingError, HANDLE_FMODE, CONTENTS_FMODE, FILE_FMODE, PickleError,
     PickleWarning, PicklingWarning, UnpicklingWarning,
 )
-from . import source, temp, detect
+from . import source, temp, detect, logger
 
 # get global settings
 from .settings import settings
 
 # make sure "trace" is turned off
-detect.trace(False)
+logger.trace(False)
 
 from importlib import reload
 

dill/logger.py

@@ -107,7 +107,7 @@ class TraceAdapter(logging.LoggerAdapter):
 
     Usage of logger with 'trace()' method:
 
-    >>> from .logger import adapter as logger  # instead of 'from .logger import logger'
+    >>> from dill.logger import adapter as logger  #NOTE: not dill.logger.logger
     >>> ...
     >>> def save_atype(pickler, obj):
     >>>     logger.trace(pickler, "Message with %s and %r etc. placeholders", 'text', obj)

docs/source/dill.rst

@@ -25,6 +25,18 @@ detect module
     :imported-members:
 ..  :exclude-members: ismethod, isfunction, istraceback, isframe, iscode, parent, reference, at, parents, children
 
+logger module
+-------------
+
+.. automodule:: dill.logger
+    :members:
+    :undoc-members:
+    :private-members:
+    :special-members:
+    :show-inheritance:
+    :imported-members:
+..  :exclude-members:
+
 objtypes module
 ---------------