Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2018-03-16 11:55:29 +0300
committerGitHub <noreply@github.com>2018-03-16 11:55:29 +0300
commitd5e38b6e80ca3d3df86e3e16fbf455dcc9aa1fa1 (patch)
treec1c596c0c36dc5f23cbf96c43f9c784d42db7a31
parent4cebc4399ca2cd26080695b136703f8c050497b8 (diff)
parentb3cbfc2bb582313a1229b06c8fcbbd34f5b9c994 (diff)
Merge pull request #4741 from tk0miya/update_deprecation_list
Update deprecation list
-rw-r--r--CHANGES18
-rw-r--r--doc/extdev/index.rst61
2 files changed, 71 insertions, 8 deletions
diff --git a/CHANGES b/CHANGES
index 6daf0ce12..f79078244 100644
--- a/CHANGES
+++ b/CHANGES
@@ -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
--------------
diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst
index 6ce3fd899..062467dbc 100644
--- a/doc/extdev/index.rst
+++ b/doc/extdev/index.rst
@@ -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