From a2c4ed6614c39f2d8721766669672b454400d314 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 31 May 2018 16:10:38 +0900 Subject: [PATCH 1/3] Fix wrong module name in CHANGES --- CHANGES | 18 +++++++++--------- doc/extdev/index.rst | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/CHANGES b/CHANGES index add6c1735..f670f63ba 100644 --- a/CHANGES +++ b/CHANGES @@ -65,15 +65,15 @@ Deprecated * ``env.read_doc()`` is deprecated * ``sphinx.writers.latex.Table.caption_footnotetexts`` is deprecated * ``sphinx.writers.latex.Table.header_footnotetexts`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.footnotestack`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.in_container_literal_block`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.next_section_ids`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.next_hyperlink_ids`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.restrict_footnote()`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.unrestrict_footnote()`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.push_hyperlink_ids()`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.pop_hyperlink_ids()`` is deprecated -* ``sphinx.writers.latex.LaTeXWriter.bibitems`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.footnotestack`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.in_container_literal_block`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.next_section_ids`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.restrict_footnote()`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.bibitems`` is deprecated * ``BuildEnvironment.load()`` is deprecated * ``BuildEnvironment.loads()`` is deprecated * ``BuildEnvironment.frompickle()`` is deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 2d0c9162e..38f4e22b9 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -171,47 +171,47 @@ The following is a list of deprecated interface. - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.footnotestack`` + * - ``sphinx.writers.latex.LaTeXTranslator.footnotestack`` - 1.8 - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.in_container_literal_block`` + * - ``sphinx.writers.latex.LaTeXTranslator.in_container_literal_block`` - 1.8 - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.next_section_ids`` + * - ``sphinx.writers.latex.LaTeXTranslator.next_section_ids`` - 1.8 - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.next_hyperlink_ids`` + * - ``sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids`` - 1.8 - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.restrict_footnote()`` + * - ``sphinx.writers.latex.LaTeXTranslator.restrict_footnote()`` - 1.8 - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.unrestrict_footnote()`` + * - ``sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()`` - 1.8 - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.push_hyperlink_ids()`` + * - ``sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()`` - 1.8 - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.pop_hyperlink_ids()`` + * - ``sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()`` - 1.8 - 3.0 - N/A - * - ``sphinx.writers.latex.LaTeXWriter.bibitems`` + * - ``sphinx.writers.latex.LaTeXTranslator.bibitems`` - 1.8 - 3.0 - N/A From e081b1f154a7fbdef85d660cea2bffaa4a49d20e Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 31 May 2018 16:14:40 +0900 Subject: [PATCH 2/3] Reorder deprecated APIs (env) --- CHANGES | 20 ++++++++++-------- doc/extdev/index.rst | 50 ++++++++++++++++++++++---------------------- 2 files changed, 36 insertions(+), 34 deletions(-) diff --git a/CHANGES b/CHANGES index f670f63ba..8c06a1122 100644 --- a/CHANGES +++ b/CHANGES @@ -47,11 +47,8 @@ Deprecated 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 * ``sphinx.locale.l_()`` is deprecated * #2157: helper function ``warn()`` for HTML themes is deprecated -* ``env._nitpick_ignore`` is deprecated * ``app.override_domain()`` is deprecated * ``app.add_stylesheet()`` is deprecated * ``app.add_javascript()`` is deprecated @@ -62,7 +59,18 @@ Deprecated * ``Config.check_unicode()`` is deprecated * ``sphinx.application.CONFIG_FILENAME`` is deprecated * ``highlightlang`` directive is deprecated +* ``BuildEnvironment.load()`` is deprecated +* ``BuildEnvironment.loads()`` is deprecated +* ``BuildEnvironment.frompickle()`` is deprecated * ``env.read_doc()`` is deprecated +* ``env.update()`` is deprecated +* ``env._read_serial()`` is deprecated +* ``env._read_parallel()`` is deprecated +* ``env.write_doctree()`` is deprecated +* ``env._nitpick_ignore`` is deprecated +* ``env.dump()`` is deprecated +* ``env.dumps()`` is deprecated +* ``env.topickle()`` is deprecated * ``sphinx.writers.latex.Table.caption_footnotetexts`` is deprecated * ``sphinx.writers.latex.Table.header_footnotetexts`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.footnotestack`` is deprecated @@ -74,12 +82,6 @@ Deprecated * ``sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.bibitems`` is deprecated -* ``BuildEnvironment.load()`` is deprecated -* ``BuildEnvironment.loads()`` is deprecated -* ``BuildEnvironment.frompickle()`` is deprecated -* ``BuildEnvironment.dump()`` is deprecated -* ``BuildEnvironment.dumps()`` is deprecated -* ``BuildEnvironment.topickle()`` is deprecated * ``sphinx.ext.mathbase.math`` node is deprecated * ``sphinx.ext.mathbase.displaymath`` node is deprecated * ``sphinx.ext.mathbase.eqref`` node is deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 38f4e22b9..0f3e6f5f0 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -287,6 +287,31 @@ The following is a list of deprecated interface. - 3.0 - :confval:`nitpick_ignore` + * - ``BuildEnvironment.update()`` + - 1.8 + - 3.0 + - ``Builder.read()`` + + * - ``BuildEnvironment.read_doc()`` + - 1.8 + - 3.0 + - ``Builder.read_doc()`` + + * - ``BuildEnvironment._read_serial()`` + - 1.8 + - 3.0 + - ``Builder.read()`` + + * - ``BuildEnvironment._read_parallel()`` + - 1.8 + - 3.0 + - ``Builder.read()`` + + * - ``BuildEnvironment.write_doctree()`` + - 1.8 + - 3.0 + - ``Builder.write_doctree()`` + * - ``warn()`` (template helper function) - 1.8 - 3.0 @@ -318,31 +343,6 @@ The following is a list of deprecated interface. - 3.0 - ``sphinx.cmd.build`` - * - ``BuildEnvironment.update()`` - - 1.8 - - 3.0 - - ``Builder.read()`` - - * - ``BuildEnvironment.read_doc()`` - - 1.8 - - 3.0 - - ``Builder.read_doc()`` - - * - ``BuildEnvironment._read_serial()`` - - 1.8 - - 3.0 - - ``Builder.read()`` - - * - ``BuildEnvironment._read_parallel()`` - - 1.8 - - 3.0 - - ``Builder.read()`` - - * - ``BuildEnvironment.write_doctree()`` - - 1.8 - - 3.0 - - ``Builder.write_doctree()`` - * - ``sphinx.locale.l_()`` - 1.8 - 3.0 From b914327317d2547b73efaf488a49c31e2e660806 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 31 May 2018 16:20:31 +0900 Subject: [PATCH 3/3] Reorder deprecated APIs (app) --- CHANGES | 6 +++--- doc/extdev/index.rst | 25 +++++++++++++------------ 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/CHANGES b/CHANGES index 8c06a1122..3f5de8050 100644 --- a/CHANGES +++ b/CHANGES @@ -40,11 +40,8 @@ Deprecated ---------- * :confval:`source_parsers` is deprecated -* ``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 * ``sphinx.util.docutils.directive_helper()`` is deprecated * ``sphinx.cmdline`` is deprecated * ``sphinx.locale.l_()`` is deprecated @@ -52,6 +49,9 @@ Deprecated * ``app.override_domain()`` is deprecated * ``app.add_stylesheet()`` is deprecated * ``app.add_javascript()`` is deprecated +* ``app.import_object()`` is deprecated +* ``app.add_source_parser()`` has changed; the *suffix* argument has been + deprecated * ``sphinx.versioning.prepare()`` is deprecated * ``Config.__init__()`` has changed; the *dirname*, *filename* and *tags* argument has been deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 0f3e6f5f0..194be710b 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -247,11 +247,23 @@ The following is a list of deprecated interface. - 3.0 - ``sphinx.versioning.UIDTransform`` - * - ``sphinx.application.Sphinx.override_domain()`` + * - ``Sphinx.override_domain()`` - 1.8 - 3.0 - :meth:`~sphinx.application.Sphinx.add_domain()` + * - ``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()` + + * - ``BuildEnvironment.load()`` - 1.8 - 3.0 @@ -322,17 +334,6 @@ The following is a list of deprecated interface. - 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