mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
refactor: autosummary: Deprecate _simple_info() and _simple_warn()
This commit is contained in:
2
CHANGES
2
CHANGES
@@ -13,6 +13,8 @@ Deprecated
|
||||
* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
|
||||
* ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter``
|
||||
* ``sphinx.ext.autodoc.importer.get_module_members()``
|
||||
* ``sphinx.ext.autosummary.generate._simple_info()``
|
||||
* ``sphinx.ext.autosummary.generate._simple_warn()``
|
||||
|
||||
Features added
|
||||
--------------
|
||||
|
@@ -36,6 +36,16 @@ The following is a list of deprecated interfaces.
|
||||
- 5.0
|
||||
- ``sphinx.ext.autodoc.ModuleDocumenter.get_module_members()``
|
||||
|
||||
* - ``sphinx.ext.autosummary.generate._simple_info()``
|
||||
- 3.5
|
||||
- 5.0
|
||||
- :ref:`logging-api`
|
||||
|
||||
* - ``sphinx.ext.autosummary.generate._simple_warn()``
|
||||
- 3.5
|
||||
- 5.0
|
||||
- :ref:`logging-api`
|
||||
|
||||
* - The ``follow_wrapped`` argument of ``sphinx.util.inspect.signature()``
|
||||
- 3.4
|
||||
- 5.0
|
||||
|
@@ -101,10 +101,14 @@ def setup_documenters(app: Any) -> None:
|
||||
|
||||
|
||||
def _simple_info(msg: str) -> None:
|
||||
warnings.warn('_simple_info() is deprecated.',
|
||||
RemovedInSphinx50Warning, stacklevel=2)
|
||||
print(msg)
|
||||
|
||||
|
||||
def _simple_warn(msg: str) -> None:
|
||||
warnings.warn('_simple_warn() is deprecated.',
|
||||
RemovedInSphinx50Warning, stacklevel=2)
|
||||
print('WARNING: ' + msg, file=sys.stderr)
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user