Update deprecation list

This commit is contained in:
Takeshi KOMIYA 2018-03-05 21:26:35 +09:00
parent 2994c12513
commit b3cbfc2bb5
2 changed files with 71 additions and 8 deletions

18
CHANGES
View File

@ -19,19 +19,21 @@ Incompatible changes
Deprecated
----------
* :confval:`source_parsers` is deprecated. Please use ``add_source_parser()``
* :confval:`source_parsers` is deprecated
instead.
* ``Application.import_object()`` is deprecated. Please use
``sphinx.util.import_object()`` instead.
* ``Application.import_object()`` is deprecated
* Drop function based directive support. For now, Sphinx only supports class
based directives.
* ``Sphinx.add_source_parser()`` has changed; the *suffix* argument has
been deprecated. Please use ``Sphinx.add_source_suffix()`` instead.
* ``sphinx.util.docutils.directive_helper()`` is deprecated.
* ``sphinx.cmdline`` is deprecated. Please use ``sphinx.cmd.build`` instead.
been deprecated
* ``sphinx.util.docutils.directive_helper()`` is deprecated
* ``sphinx.cmdline`` is deprecated
* All ``env.update()``, ``env._read_serial()`` and ``env._read_parallel()`` are
deprecated. Please use ``builder.read()`` instead.
* ``sphinx.locale.l_()`` is deprecated. Please use ``_()`` instead
deprecated
* ``sphinx.locale.l_()`` is deprecated
For more details, see `deprecation APIs list
<http://www.sphinx-doc.org/en/master/extdev/index.html#deprecated-apis>`_
Features added
--------------

View File

@ -113,6 +113,67 @@ The following is a list of deprecated interface.
- (will be) Removed
- Alternatives
* - :confval:`source_parsers`
- 1.8
- 3.0
- :meth:`~sphinx.application.Sphinx.add_source_parser()`
* - ``Sphinx.import_object()``
- 1.8
- 3.0
- ``sphinx.util.import_object()``
* - ``suffix`` argument of
:meth:`~sphinx.application.Sphinx.add_source_parser()`
- 1.8
- 3.0
- :meth:`~sphinx.application.Sphinx.add_source_suffix()`
* - ``sphinx.util.docutils.directive_helper()``
- 1.8
- 3.0
- ``Directive`` class of docutils
* - ``sphinx.cmdline``
- 1.8
- 3.0
- ``sphinx.cmd.build``
* - ``BuildEnvironment.update()``
- 1.8
- 3.0
- ``Builder.read()``
* - ``BuildEnvironment._read_serial()``
- 1.8
- 3.0
- ``Builder.read()``
* - ``BuildEnvironment._read_parallel()``
- 1.8
- 3.0
- ``Builder.read()``
* - ``sphinx.locale.l_()``
- 1.8
- 3.0
- :func:`sphinx.locale._()`
* - ``sphinx.locale.lazy_gettext()``
- 1.8
- 3.0
- :func:`sphinx.locale._()`
* - ``sphinx.locale.mygettext()``
- 1.8
- 3.0
- :func:`sphinx.locale._()`
* - ``sphinx.util.copy_static_entry()``
- 1.5
- 3.0
- ``sphinx.util.fileutil.copy_asset()``
* - ``sphinx.build_main()``
- 1.7
- 2.0