IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

refactor: autosummary: Deprecate _simple_info() and _simple_warn()

Browse Source
This commit is contained in:
Takeshi KOMIYA
2021-01-20 02:23:34 +09:00
parent a7b6b6bb7f
commit d49f3a1c78
3 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@@ -13,6 +13,8 @@ Deprecated
* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()`` * ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
* ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter`` * ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter``
* ``sphinx.ext.autodoc.importer.get_module_members()`` * ``sphinx.ext.autodoc.importer.get_module_members()``
* ``sphinx.ext.autosummary.generate._simple_info()``
* ``sphinx.ext.autosummary.generate._simple_warn()``
Features added Features added
-------------- --------------

10
doc/extdev/deprecated.rst
View File

@@ -36,6 +36,16 @@ The following is a list of deprecated interfaces.
- 5.0 - 5.0
- ``sphinx.ext.autodoc.ModuleDocumenter.get_module_members()`` - ``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()`` * - The ``follow_wrapped`` argument of ``sphinx.util.inspect.signature()``
- 3.4 - 3.4
- 5.0 - 5.0

4
sphinx/ext/autosummary/generate.py
View File

@@ -101,10 +101,14 @@ def setup_documenters(app: Any) -> None:
def _simple_info(msg: str) -> None: def _simple_info(msg: str) -> None:
warnings.warn('_simple_info() is deprecated.',
RemovedInSphinx50Warning, stacklevel=2)
print(msg) print(msg)
def _simple_warn(msg: str) -> None: def _simple_warn(msg: str) -> None:
warnings.warn('_simple_warn() is deprecated.',
RemovedInSphinx50Warning, stacklevel=2)
print('WARNING: ' + msg, file=sys.stderr) print('WARNING: ' + msg, file=sys.stderr)