Deprecated APIs
***************

On developing Sphinx, we are always careful to the compatibility of
our APIs. But, sometimes, the change of interface are needed for some
reasons.  In such cases, we've marked them as deprecated. And they are
kept during the two major versions (for more details, please see
Deprecation policy).

The following is a list of deprecated interfaces.


deprecated APIs
^^^^^^^^^^^^^^^

+------------------------------------------+------------+------------+------------------------------------------+
| Target                                   | Deprecated | (will be)  | Alternatives                             |
|                                          |            | Removed    |                                          |
|==========================================|============|============|==========================================|
| "sphinx.builders.gettext.POHEADER"       | 2.3        | 4.0        | "sphinx/templates/gettext/message.pot_t" |
|                                          |            |            | (template file)                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.io.SphinxStandaloneReader.app"   | 2.3        | 4.0        | "sphinx.io.SphinxStandaloneReader.setup  |
|                                          |            |            | ()"                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.io.SphinxStandaloneReader.env"   | 2.3        | 4.0        | "sphinx.io.SphinxStandaloneReader.setup  |
|                                          |            |            | ()"                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.texescape.tex_escape_map"   | 2.3        | 4.0        | "sphinx.util.texescape.escape()"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.texescape.tex_hl_escape_ma  | 2.3        | 4.0        | "sphinx.util.texescape.hlescape()"       |
| p_new"                                   |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.n  | 2.3        | 4.0        | N/A                                      |
| o_contractions"                          |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.math.MathDomain.add_equ  | 2.2        | 4.0        | "sphinx.domains.math.MathDomain.note_eq  |
| ation()"                                 |            |            | uation()"                                |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.math.MathDomain.get_nex  | 2.2        | 4.0        | "sphinx.domains.math.MathDomain.note_eq  |
| t_equation_number()"                     |            |            | uation()"                                |
+------------------------------------------+------------+------------+------------------------------------------+
| The "info" and "warn" arguments of "sph  | 2.2        | 4.0        | "logging.info()" and "logging.warning()" |
| inx.ext.autosummary.generate.generate_a  |            |            |                                          |
| utosummary_docs()"                       |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autosummary.generate._simpl  | 2.2        | 4.0        | "logging.info()"                         |
| e_info()"                                |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autosummary.generate._simpl  | 2.2        | 4.0        | "logging.warning()"                      |
| e_warn()"                                |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.todo.merge_info()"           | 2.2        | 4.0        | "sphinx.ext.todo.TodoDomain"             |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.todo.process_todo_nodes()"   | 2.2        | 4.0        | "sphinx.ext.todo.TodoDomain"             |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.todo.process_todos()"        | 2.2        | 4.0        | "sphinx.ext.todo.TodoDomain"             |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.todo.purge_todos()"          | 2.2        | 4.0        | "sphinx.ext.todo.TodoDomain"             |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.latex.LaTeXBuilder.app  | 2.1        | 4.0        | N/A                                      |
| ly_transforms()"                         |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders._epub_base.EpubBuilder  | 2.1        | 4.0        | "html.escape()"                          |
| .esc()"                                  |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Acks"                 | 2.1        | 4.0        | "sphinx.directives.other.Acks"           |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Author"               | 2.1        | 4.0        | "sphinx.directives.other.Author"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Centered"             | 2.1        | 4.0        | "sphinx.directives.other.Centered"       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Class"                | 2.1        | 4.0        | "sphinx.directives.other.Class"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.CodeBlock"            | 2.1        | 4.0        | "sphinx.directives.code.CodeBlock"       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Figure"               | 2.1        | 4.0        | "sphinx.directives.patches.Figure"       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.HList"                | 2.1        | 4.0        | "sphinx.directives.other.HList"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Highlight"            | 2.1        | 4.0        | "sphinx.directives.code.Highlight"       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Include"              | 2.1        | 4.0        | "sphinx.directives.other.Include"        |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Index"                | 2.1        | 4.0        | "sphinx.directives.other.Index"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.LiteralInclude"       | 2.1        | 4.0        | "sphinx.directives.code.LiteralInclude"  |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Meta"                 | 2.1        | 4.0        | "sphinx.directives.patches.Meta"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.Only"                 | 2.1        | 4.0        | "sphinx.directives.other.Only"           |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.SeeAlso"              | 2.1        | 4.0        | "sphinx.directives.other.SeeAlso"        |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.TabularColumns"       | 2.1        | 4.0        | "sphinx.directives.other.TabularColumns" |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.TocTree"              | 2.1        | 4.0        | "sphinx.directives.other.TocTree"        |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.VersionChange"        | 2.1        | 4.0        | "sphinx.directives.other.VersionChange"  |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.python.PyClassmember"    | 2.1        | 4.0        | "sphinx.domains.python.PyAttribute",     |
|                                          |            |            | "sphinx.domains.python.PyMethod",        |
|                                          |            |            | "sphinx.domains.python.PyClassMethod",   |
|                                          |            |            | "sphinx.domains.python.PyObject" and     |
|                                          |            |            | "sphinx.domains.python.PyStaticMethod"   |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.python.PyModulelevel"    | 2.1        | 4.0        | "sphinx.domains.python.PyFunction",      |
|                                          |            |            | "sphinx.domains.python.PyObject" and     |
|                                          |            |            | "sphinx.domains.python.PyVariable"       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.std.StandardDomain._res  | 2.1        | 4.0        | "sphinx.domains.citation.CitationDomain  |
| olve_citation_xref()"                    |            |            | .resolve_xref()"                         |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.std.StandardDomain.note  | 2.1        | 4.0        | "sphinx.domains.citation.CitationDomain  |
| _citations()"                            |            |            | .note_citation()"                        |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.std.StandardDomain.note  | 2.1        | 4.0        | "sphinx.domains.citation.CitationDomain  |
| _citation_refs()"                        |            |            | .note_citation_reference()"              |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.std.StandardDomain.note  | 2.1        | 4.0        | "sphinx.domains.std.StandardDomain.proc  |
| _labels()"                               |            |            | ess_doc()"                               |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.environment.NoUri"               | 2.1        | 4.0        | "sphinx.errors.NoUri"                    |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.apidoc.format_directive()"   | 2.1        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.apidoc.format_heading()"     | 2.1        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.apidoc.makename()"           | 2.1        | 4.0        | "sphinx.ext.apidoc.module_join()"        |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.importer.MockFinder" | 2.1        | 4.0        | "sphinx.ext.autodoc.mock.MockFinder"     |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.importer.MockLoader" | 2.1        | 4.0        | "sphinx.ext.autodoc.mock.MockLoader"     |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.importer.mock()"     | 2.1        | 4.0        | "sphinx.ext.autodoc.mock.mock()"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autosummary.autolink_role()" | 2.1        | 4.0        | "sphinx.ext.autosummary.AutoLink"        |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.imgmath.DOC_BODY"            | 2.1        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.imgmath.DOC_BODY_PREVIEW"    | 2.1        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.imgmath.DOC_HEAD"            | 2.1        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.transforms.CitationReferences"   | 2.1        | 4.0        | "sphinx.domains.citation.CitationRefere  |
|                                          |            |            | nceTransform"                            |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.transforms.SmartQuotesSkipper"   | 2.1        | 4.0        | "sphinx.domains.citation.CitationDefini  |
|                                          |            |            | tionTransform"                           |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.docfields.DocFieldTransfor  | 2.1        | 4.0        | "sphinx.directives.ObjectDescription.ge  |
| mer.preprocess_fieldtypes()"             |            |            | t_field_type_map()"                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.node.find_source_node()"    | 2.1        | 4.0        | "sphinx.util.node.get_node_source()"     |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.i18n.find_catalog()"        | 2.1        | 4.0        | "sphinx.util.i18n.docname_to_domain()"   |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.i18n.find_catalog_files()"  | 2.1        | 4.0        | "sphinx.util.i18n.CatalogRepository"     |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.i18n.find_catalog_source_f  | 2.1        | 4.0        | "sphinx.util.i18n.CatalogRepository"     |
| iles()"                                  |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "encoding" argument of                   | 2.0        | 4.0        | N/A                                      |
| "autodoc.Documenter.get_doc()", "autodo  |            |            |                                          |
| c.DocstringSignatureMixin.get_doc()", "  |            |            |                                          |
| autodoc.DocstringSignatureMixin._find_s  |            |            |                                          |
| ignature()", and                         |            |            |                                          |
| "autodoc.ClassDocumenter.get_doc()"      |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| arguments of                             | 2.0        | 4.0        | N/A                                      |
| "EpubBuilder.build_mimetype()",          |            |            |                                          |
| "EpubBuilder.build_container()",         |            |            |                                          |
| "EpubBuilder.build_content()",           |            |            |                                          |
| "EpubBuilder.build_toc()" and            |            |            |                                          |
| "EpubBuilder.build_epub()"               |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| arguments of                             | 2.0        | 4.0        | N/A                                      |
| "Epub3Builder.build_navigation_doc()"    |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "nodetype" argument of "sphinx.search.W  | 2.0        | 4.0        | N/A                                      |
| ordCollector.is_meta_keywords()"         |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "suffix" argument of                     | 2.0        | 4.0        | N/A                                      |
| "BuildEnvironment.doc2path()"            |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| string style "base" argument of          | 2.0        | 4.0        | "os.path.join()"                         |
| "BuildEnvironment.doc2path()"            |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.addnodes.abbreviation"           | 2.0        | 4.0        | "docutils.nodes.abbreviation"            |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.applehelp"              | 2.0        | 4.0        | "sphinxcontrib.applehelp"                |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.devhelp"                | 2.0        | 4.0        | "sphinxcontrib.devhelp"                  |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.epub3.Epub3Builder.val  | 2.0        | 4.0        | "sphinx.builders.epub3.validate_config_  |
| idate_config_value()"                    |            |            | values()"                                |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.html.JSONHTMLBuilder"   | 2.0        | 4.0        | "sphinx.builders.serializinghtml.JSONHT  |
|                                          |            |            | MLBuilder"                               |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.html.PickleHTMLBuilder" | 2.0        | 4.0        | "sphinx.builders.serializinghtml.Pickle  |
|                                          |            |            | HTMLBuilder"                             |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.html.SerializingHTMLBu  | 2.0        | 4.0        | "sphinx.builders.serializinghtml.Serial  |
| ilder"                                   |            |            | izingHTMLBuilder"                        |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.html.SingleFileHTMLBui  | 2.0        | 4.0        | "sphinx.builders.singlehtml.SingleFileH  |
| lder"                                    |            |            | TMLBuilder"                              |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.html.WebHTMLBuilder"    | 2.0        | 4.0        | "sphinx.builders.serializinghtml.Pickle  |
|                                          |            |            | HTMLBuilder"                             |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.htmlhelp"               | 2.0        | 4.0        | "sphinxcontrib.htmlhelp"                 |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.htmlhelp.HTMLHelpBuild  | 2.0        | 4.0        | "open()"                                 |
| er.open_file()"                          |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.builders.qthelp"                 | 2.0        | 4.0        | "sphinxcontrib.qthelp"                   |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.cmd.quickstart.term_decode()"    | 2.0        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.cmd.quickstart.TERM_ENCODING"    | 2.0        | 4.0        | "sys.stdin.encoding"                     |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.config.check_unicode()"          | 2.0        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.config.string_classes"           | 2.0        | 4.0        | "[str]"                                  |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.cpp.DefinitionError.des  | 2.0        | 4.0        | "str(exc)"                               |
| cription"                                |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.cpp.NoOldIdError.descri  | 2.0        | 4.0        | "str(exc)"                               |
| ption"                                   |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.domains.cpp.UnsupportedMultiCha  | 2.0        | 4.0        | "str(exc)"                               |
| racterCharLiteral.decoded"               |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autosummary.Autosummary.war  | 2.0        | 4.0        | N/A                                      |
| n()"                                     |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autosummary.Autosummary.gen  | 2.0        | 4.0        | N/A                                      |
| opt"                                     |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autosummary.Autosummary.war  | 2.0        | 4.0        | N/A                                      |
| nings"                                   |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autosummary.Autosummary.res  | 2.0        | 4.0        | N/A                                      |
| ult"                                     |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.doctest.doctest_encode()"    | 2.0        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.jsmath"                      | 2.0        | 4.0        | "sphinxcontrib.jsmath"                   |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.roles.abbr_role()"               | 2.0        | 4.0        | "sphinx.roles.Abbreviation"              |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.roles.emph_literal_role()"       | 2.0        | 4.0        | "sphinx.roles.EmphasizedLiteral"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.roles.menusel_role()"            | 2.0        | 4.0        | "sphinx.roles.GUILabel" or               |
|                                          |            |            | "sphinx.roles.MenuSelection"             |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.roles.index_role()"              | 2.0        | 4.0        | "sphinx.roles.Index"                     |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.roles.indexmarkup_role()"        | 2.0        | 4.0        | "sphinx.roles.PEP" or "sphinx.roles.RFC" |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.testing.util.remove_unicode_lit  | 2.0        | 4.0        | N/A                                      |
| eral()"                                  |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.attrdict"                   | 2.0        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.force_decode()"             | 2.0        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.get_matching_docs()"        | 2.0        | 4.0        | "sphinx.util.get_matching_files()"       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.inspect.Parameter"          | 2.0        | 3.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.jsonimpl"                   | 2.0        | 4.0        | "sphinxcontrib.serializinghtml.jsonimpl" |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.osutil.EEXIST"              | 2.0        | 4.0        | "errno.EEXIST" or "FileExistsError"      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.osutil.EINVAL"              | 2.0        | 4.0        | "errno.EINVAL"                           |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.osutil.ENOENT"              | 2.0        | 4.0        | "errno.ENOENT" or "FileNotFoundError"    |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.osutil.EPIPE"               | 2.0        | 4.0        | "errno.ENOENT" or "BrokenPipeError"      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.osutil.walk()"              | 2.0        | 4.0        | "os.walk()"                              |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.pycompat.NoneType"          | 2.0        | 4.0        | "sphinx.util.typing.NoneType"            |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.pycompat.TextIOWrapper"     | 2.0        | 4.0        | "io.TextIOWrapper"                       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.pycompat.UnicodeMixin"      | 2.0        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.pycompat.htmlescape()"      | 2.0        | 4.0        | "html.escape()"                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.pycompat.indent()"          | 2.0        | 4.0        | "textwrap.indent()"                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.pycompat.sys_encoding"      | 2.0        | 4.0        | "sys.getdefaultencoding()"               |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.pycompat.terminal_safe()"   | 2.0        | 4.0        | "sphinx.util.console.terminal_safe()"    |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.pycompat.u"                 | 2.0        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.PeekableIterator"           | 2.0        | 4.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| Omitting the "filename" argument in an   | 2.0        | 4.0        | "IndexBuilder.feed(docname, filename,    |
| overriddent "IndexBuilder.feed()"        |            |            | title, doctree)"                         |
| method.                                  |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.ExtBabel"          | 2.0        | 4.0        | "sphinx.builders.latex.util.ExtBabel"    |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.b  | 2.0        | 4.0        | N/A                                      |
| abel_defmacro()"                         |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.application.Sphinx._setting_up_  | 2.0        | 3.0        | N/A                                      |
| extension"                               |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| The "importer" argument of "sphinx.ext.  | 2.0        | 3.0        | N/A                                      |
| autodoc.importer._MockModule"            |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.importer._MockImpor  | 2.0        | 3.0        | N/A                                      |
| ter"                                     |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.io.SphinxBaseFileInput"          | 2.0        | 3.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.io.SphinxFileInput.supported"    | 2.0        | 3.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.io.SphinxRSTFileInput"           | 2.0        | 3.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.registry.SphinxComponentRegistr  | 2.0        | 3.0        | N/A                                      |
| y.add_source_input()"                    |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator._  | 2.0        | 3.0        | N/A                                      |
| make_visit_admonition()"                 |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.c  | 2.0        | 4.0        | N/A                                      |
| ollect_footnotes()"                      |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.texinfo.TexinfoTranslat  | 2.0        | 3.0        | N/A                                      |
| or._make_visit_admonition()"             |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.text.TextTranslator._ma  | 2.0        | 3.0        | N/A                                      |
| ke_depart_admonition()"                  |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.g  | 2.0        | 4.0        | N/A                                      |
| enerate_numfig_format()"                 |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "highlightlang"                          | 1.8        | 4.0        | "highlight"                              |
+------------------------------------------+------------+------------+------------------------------------------+
| "add_stylesheet()"                       | 1.8        | 4.0        | "add_css_file()"                         |
+------------------------------------------+------------+------------+------------------------------------------+
| "add_javascript()"                       | 1.8        | 4.0        | "add_js_file()"                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "autodoc_default_flags"                  | 1.8        | 4.0        | "autodoc_default_options"                |
+------------------------------------------+------------+------------+------------------------------------------+
| "content" arguments of                   | 1.8        | 3.0        | N/A                                      |
| "sphinx.util.image.guess_mimetype()"     |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "gettext_compact" arguments of "sphinx.  | 1.8        | 3.0        | N/A                                      |
| util.i18n.find_catalog_source_files()"   |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.io.SphinxI18nReader.set_lineno_  | 1.8        | 3.0        | N/A                                      |
| for_reporter()"                          |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.io.SphinxI18nReader.line"        | 1.8        | 3.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.directives.other.VersionChanges" | 1.8        | 3.0        | "sphinx.domains.changeset.VersionChange  |
|                                          |            |            | s"                                       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.highlighting.PygmentsBridge.unh  | 1.8        | 3.0        | N/A                                      |
| ighlight()"                              |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "trim_doctest_flags" arguments of        | 1.8        | 3.0        | N/A                                      |
| "sphinx.highlighting.PygmentsBridge"     |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase"                    | 1.8        | 3.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.MathDomain"         | 1.8        | 3.0        | "sphinx.domains.math.MathDomain"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.MathDirective"      | 1.8        | 3.0        | "sphinx.directives.patches.MathDirectiv  |
|                                          |            |            | e"                                       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.math_role()"        | 1.8        | 3.0        | "docutils.parsers.rst.roles.math_role()" |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.setup_math()"       | 1.8        | 3.0        | "add_html_math_renderer()"               |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.is_in_section_titl  | 1.8        | 3.0        | N/A                                      |
| e()"                                     |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.get_node_equation_  | 1.8        | 3.0        | "sphinx.util.math.get_node_equation_num  |
| number()"                                |            |            | ber()"                                   |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.wrap_displaymath()" | 1.8        | 3.0        | "sphinx.util.math.wrap_displaymath()"    |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.math" (node)        | 1.8        | 3.0        | "docutils.nodes.math"                    |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.displaymath" (node) | 1.8        | 3.0        | "docutils.nodes.math_block"              |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.mathbase.eqref" (node)       | 1.8        | 3.0        | "sphinx.builders.latex.nodes.math_refer  |
|                                          |            |            | ence"                                    |
+------------------------------------------+------------+------------+------------------------------------------+
| "viewcode_import" (config value)         | 1.8        | 3.0        | "viewcode_follow_imported_members"       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.Table.caption_foo  | 1.8        | 3.0        | N/A                                      |
| tnotetexts"                              |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.Table.header_foot  | 1.8        | 3.0        | N/A                                      |
| notetexts"                               |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.f  | 1.8        | 3.0        | N/A                                      |
| ootnotestack"                            |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.i  | 1.8        | 3.0        | N/A                                      |
| n_container_literal_block"               |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.n  | 1.8        | 3.0        | N/A                                      |
| ext_section_ids"                         |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.n  | 1.8        | 3.0        | N/A                                      |
| ext_hyperlink_ids"                       |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.r  | 1.8        | 3.0        | N/A                                      |
| estrict_footnote()"                      |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.u  | 1.8        | 3.0        | N/A                                      |
| nrestrict_footnote()"                    |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.p  | 1.8        | 3.0        | N/A                                      |
| ush_hyperlink_ids()"                     |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.p  | 1.8        | 3.0        | N/A                                      |
| op_hyperlink_ids()"                      |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.b  | 1.8        | 3.0        | N/A                                      |
| ibitems"                                 |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.h  | 1.8        | 3.0        | N/A                                      |
| lsettingstack"                           |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.ExtBabel.get_shor  | 1.8        | 3.0        | N/A                                      |
| thandoff()"                              |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.html.HTMLTranslator.hig  | 1.8        | 3.0        | N/A                                      |
| hlightlang()"                            |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.html.HTMLTranslator.hig  | 1.8        | 3.0        | N/A                                      |
| hlightlang_base()"                       |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.html.HTMLTranslator.hig  | 1.8        | 3.0        | N/A                                      |
| hlightlangopts()"                        |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.html.HTMLTranslator.hig  | 1.8        | 3.0        | N/A                                      |
| hlightlinenothreshold()"                 |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.html5.HTMLTranslator.hi  | 1.8        | 3.0        | N/A                                      |
| ghlightlang()"                           |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.html5.HTMLTranslator.hi  | 1.8        | 3.0        | N/A                                      |
| ghlightlang_base()"                      |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.html5.HTMLTranslator.hi  | 1.8        | 3.0        | N/A                                      |
| ghlightlangopts()"                       |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.html5.HTMLTranslator.hi  | 1.8        | 3.0        | N/A                                      |
| ghlightlinenothreshold()"                |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.writers.latex.LaTeXTranslator.c  | 1.8        | 3.0        | Nothing                                  |
| heck_latex_elements()"                   |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.application.CONFIG_FILENAME"     | 1.8        | 3.0        | "sphinx.config.CONFIG_FILENAME"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "Config.check_unicode()"                 | 1.8        | 3.0        | "sphinx.config.check_unicode()"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "Config.check_types()"                   | 1.8        | 3.0        | "sphinx.config.check_confval_types()"    |
+------------------------------------------+------------+------------+------------------------------------------+
| "dirname", "filename" and "tags"         | 1.8        | 3.0        | "Config.read()"                          |
| arguments of "Config.__init__()"         |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| The value of "html_search_options"       | 1.8        | 3.0        | see "html_search_options"                |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.versioning.prepare()"            | 1.8        | 3.0        | "sphinx.versioning.UIDTransform"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "Sphinx.override_domain()"               | 1.8        | 3.0        | "add_domain()"                           |
+------------------------------------------+------------+------------+------------------------------------------+
| "Sphinx.import_object()"                 | 1.8        | 3.0        | "sphinx.util.import_object()"            |
+------------------------------------------+------------+------------+------------------------------------------+
| "suffix" argument of                     | 1.8        | 3.0        | "add_source_suffix()"                    |
| "add_source_parser()"                    |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.load()"                | 1.8        | 3.0        | "pickle.load()"                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.loads()"               | 1.8        | 3.0        | "pickle.loads()"                         |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.frompickle()"          | 1.8        | 3.0        | "pickle.load()"                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.dump()"                | 1.8        | 3.0        | "pickle.dump()"                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.dumps()"               | 1.8        | 3.0        | "pickle.dumps()"                         |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.topickle()"            | 1.8        | 3.0        | "pickle.dump()"                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment._nitpick_ignore"       | 1.8        | 3.0        | "nitpick_ignore"                         |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.versionchanges"        | 1.8        | 3.0        | N/A                                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "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()"                |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.note_versionchange()"  | 1.8        | 3.0        | "ChangesDomain.note_changeset()"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "warn()" (template helper function)      | 1.8        | 3.0        | "warning()"                              |
+------------------------------------------+------------+------------+------------------------------------------+
| "source_parsers"                         | 1.8        | 3.0        | "add_source_parser()"                    |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.docutils.directive_helper(  | 1.8        | 3.0        | "Directive" class of docutils            |
| )"                                       |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.cmdline"                         | 1.8        | 3.0        | "sphinx.cmd.build"                       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.make_mode"                       | 1.8        | 3.0        | "sphinx.cmd.make_mode"                   |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.locale.l_()"                     | 1.8        | 3.0        | "sphinx.locale._()"                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.locale.lazy_gettext()"           | 1.8        | 3.0        | "sphinx.locale._()"                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.locale.mygettext()"              | 1.8        | 3.0        | "sphinx.locale._()"                      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.copy_static_entry()"        | 1.5        | 3.0        | "sphinx.util.fileutil.copy_asset()"      |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.build_main()"                    | 1.7        | 2.0        | "sphinx.cmd.build.build_main()"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.intersphinx.debug()"         | 1.7        | 2.0        | "sphinx.ext.intersphinx.inspect_main()"  |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.format_annotation()" | 1.7        | 2.0        | "sphinx.util.inspect.Signature"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.formatargspec()"     | 1.7        | 2.0        | "sphinx.util.inspect.Signature"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.AutodocReporter"     | 1.7        | 2.0        | "sphinx.util.docutils.switch_source_inp  |
|                                          |            |            | ut()"                                    |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.add_documenter()"    | 1.7        | 2.0        | "add_autodocumenter()"                   |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.ext.autodoc.AutoDirective._regi  | 1.7        | 2.0        | "add_autodocumenter()"                   |
| ster"                                    |            |            |                                          |
+------------------------------------------+------------+------------+------------------------------------------+
| "AutoDirective._special_attrgetters"     | 1.7        | 2.0        | "add_autodoc_attrgetter()"               |
+------------------------------------------+------------+------------+------------------------------------------+
| "Sphinx.warn()", "Sphinx.info()"         | 1.6        | 2.0        | Logging API                              |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.set_warnfunc()"        | 1.6        | 2.0        | Logging API                              |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.note_toctree()"        | 1.6        | 2.0        | "Toctree.note()" (in                     |
|                                          |            |            | "sphinx.environment.adapters.toctree")   |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.get_toc_for()"         | 1.6        | 2.0        | "Toctree.get_toc_for()" (in              |
|                                          |            |            | "sphinx.environment.adapters.toctree")   |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.get_toctree_for()"     | 1.6        | 2.0        | "Toctree.get_toctree_for()" (in          |
|                                          |            |            | "sphinx.environment.adapters.toctree")   |
+------------------------------------------+------------+------------+------------------------------------------+
| "BuildEnvironment.create_index()"        | 1.6        | 2.0        | "IndexEntries.create_index()" (in "sphi  |
|                                          |            |            | nx.environment.adapters.indexentries")   |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.websupport"                      | 1.6        | 2.0        | sphinxcontrib-websupport                 |
+------------------------------------------+------------+------------+------------------------------------------+
| "StandaloneHTMLBuilder.css_files"        | 1.6        | 2.0        | "add_stylesheet()"                       |
+------------------------------------------+------------+------------+------------------------------------------+
| "document.settings.gettext_compact"      | 1.8        | 1.8        | "gettext_compact"                        |
+------------------------------------------+------------+------------+------------------------------------------+
| "Sphinx.status_iterator()"               | 1.6        | 1.7        | "sphinx.util.status_iterator()"          |
+------------------------------------------+------------+------------+------------------------------------------+
| "Sphinx.old_status_iterator()"           | 1.6        | 1.7        | "sphinx.util.old_status_iterator()"      |
+------------------------------------------+------------+------------+------------------------------------------+
| "Sphinx._directive_helper()"             | 1.6        | 1.7        | "sphinx.util.docutils.directive_helper(  |
|                                          |            |            | )"                                       |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.compat.Directive"           | 1.6        | 1.7        | "docutils.parsers.rst.Directive"         |
+------------------------------------------+------------+------------+------------------------------------------+
| "sphinx.util.compat.docutils_version"    | 1.6        | 1.7        | "sphinx.util.docutils.__version_info__"  |
+------------------------------------------+------------+------------+------------------------------------------+

Note:

  On deprecating on public APIs (internal functions and classes), we
  also follow the policy as much as possible.
