From 6007bbf797000e818daa220aa39e46c744240024 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 21 Mar 2021 01:09:03 +0900 Subject: [PATCH] Deprecate DocumenterBridge.warn() Since 1.6, sphinx.util.logging module became the default logging interface of Sphinx. It allows sphinx-components to output log without the app (or env) object. According to the policy, DocumenterBridge.warn() is no longer needed and should be replaced by the logging module. --- CHANGES | 1 + doc/extdev/deprecated.rst | 5 +++++ sphinx/ext/autodoc/directive.py | 3 +++ 3 files changed, 9 insertions(+) diff --git a/CHANGES b/CHANGES index ae3c55280..ee7e33cb1 100644 --- a/CHANGES +++ b/CHANGES @@ -52,6 +52,7 @@ Deprecated * ``sphinx.directives.patches.ListTable`` * ``sphinx.directives.patches.RSTTable`` * ``sphinx.ext.autodoc.directive.DocumenterBridge.filename_set`` +* ``sphinx.ext.autodoc.directive.DocumenterBridge.warn()`` * ``sphinx.registry.SphinxComponentRegistry.get_source_input()`` * ``sphinx.registry.SphinxComponentRegistry.source_inputs`` * ``sphinx.transforms.FigureAligner`` diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst index 519d40f95..9e17b9fb4 100644 --- a/doc/extdev/deprecated.rst +++ b/doc/extdev/deprecated.rst @@ -47,6 +47,11 @@ The following is a list of deprecated interfaces. - 6.0 - ``sphinx.ext.autodoc.directive.DocumenterBridge.record_dependencies`` + * - ``sphinx.ext.autodoc.directive.DocumenterBridge.warn()`` + - 4.0 + - 6.0 + - :ref:`logging-api` + * - ``sphinx.registry.SphinxComponentRegistry.get_source_input()`` - 4.0 - 6.0 diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index a6608698d..8ed622d23 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -61,6 +61,9 @@ class DocumenterBridge: self.state = state def warn(self, msg: str) -> None: + warnings.warn('DocumenterBridge.warn is deprecated. Plase use sphinx.util.logging ' + 'module instead.', + RemovedInSphinx60Warning, stacklevel=2) logger.warning(msg, location=(self.env.docname, self.lineno)) @property