mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge pull request #9022 from tk0miya/deprecate_DocumenterBridge.warn
Deprecate DocumenterBridge.warn()
This commit is contained in:
1
CHANGES
1
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``
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user