Merge pull request #9022 from tk0miya/deprecate_DocumenterBridge.warn

Deprecate DocumenterBridge.warn()
This commit is contained in:
Takeshi KOMIYA
2021-03-23 01:32:05 +09:00
committed by GitHub
3 changed files with 9 additions and 0 deletions

View File

@@ -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``

View File

@@ -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

View File

@@ -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