已弃用的API

在开发 Sphinx 时,我们始终注意API的兼容性。但有时,由于某些原因需要更改接口。在这种情况下,我们会将其标记为已弃用。它们将在两个主要版本中保留(有关更多详细信息,请参阅弃用策略)。

以下是已弃用接口的列表。

已弃用的API

目标

已弃用

已移除

替代方案

sphinx.io(整个模块)

9.0

11.0

docutils.io 或标准 Python I/O

sphinx.builders.Builder.app

9.0

11.0

不适用

sphinx.environment.BuildEnvironment.app

9.0

11.0

不适用

sphinx.transforms.Transform.app

9.0

11.0

不适用

sphinx.transforms.post_transforms.SphinxPostTransform.app

9.0

11.0

不适用

sphinx.events.EventManager.app

9.0

11.0

不适用

sphinx.builders.singlehtml.SingleFileHTMLBuilder.fix_refuris

8.2

10.0

不适用

sphinx.util.FilenameUniqDict

8.1

10.0

不适用

sphinx.util.DownloadFiles

8.1

10.0

不适用

sphinx.ext.intersphinx.normalize_intersphinx_mapping

8.0

10.0

sphinx.ext.intersphinx.validate_intersphinx_mapping

sphinx.testing.util.strip_escseq

7.3

9.0

sphinx.util.console.strip_colors

sphinx-quickstart 中的旧式 Makefile 以及 -M-m--no-use-make-mode--use-make-mode 选项

7.3

9.0

内联 旧式 Makefile 模板

sphinx.ext.autodoc.preserve_defaults.get_function_def()

7.2

9.0

不适用(替代方案为私有)

sphinx.builders.html.StandaloneHTMLBuilder.css_files

7.2

9.0

不适用

sphinx.builders.html.StandaloneHTMLBuilder.script_files

7.2

9.0

不适用

sphinx.builders.html.Stylesheet

7.2

9.0

sphinx.application.Sphinx.add_css_file()

sphinx.builders.html.JavaScript

7.2

9.0

sphinx.application.Sphinx.add_js_file()

sphinx.util.split_into

7.2

9.0

不适用

sphinx.util.split_index_msg

7.2

9.0

sphinx.util.index_entries.split_index_msg

sphinx.testing.path

7.2

9.0

os.pathpathlib

sphinx.util.md5

7.2

9.0

hashlib.md5

sphinx.util.sha1

7.2

9.0

hashlib.sha1

sphinx.util.osutil.cd

6.2

8.0

contextlib.chdir

sphinx.util.save_traceback

6.1

8.0

sphinx.util.exceptions.save_traceback

sphinx.util.format_exception_cut_frames

6.1

8.0

sphinx.util.exceptions.format_exception_cut_frames

sphinx.util.epoch_to_rfc1123

6.1

8.0

sphinx.util.http_date.epoch_to_rfc1123

sphinx.util.rfc1123_to_epoch

6.1

8.0

sphinx.util.http_date.rfc1123_to_epoch

sphinx.util.status_iterator

6.1

8.0

sphinx.util.display.status_iterator

sphinx.util.display_chunk

6.1

8.0

sphinx.util.display.display_chunk

sphinx.util.SkipProgressMessage

6.1

8.0

sphinx.util.display.SkipProgressMessage

sphinx.util.progress_message

6.1

8.0

sphinx.util.display.progress_message

sphinx.util.typing.stringify

6.1

8.0

sphinx.util.typing.stringify_annotation

HTML 4 支持

5.2

7.0

不适用

sphinx.util.path_stabilize

5.1

7.0

sphinx.util.osutil.path_stabilize

sphinx.util.get_matching_files

5.1

7.0

sphinx.util.matching.get_matching_files

sphinx.ext.napoleon.iterators

5.1

7.0

pockets.iterators

sphinx.util.stemmer

5.1

7.0

snowballstemmer

sphinx.util.jsdump

5.0

7.0

标准库 json 模块。

Setuptools 集成(setup.py build_sphinx

5.0

7.0

不适用

sphinx.util.i18n:babel_format_date()locale 参数

5.0

7.0

不适用

sphinx.util.i18n:format_date()language 参数

5.0

7.0

不适用

sphinx.builders.html.html5_ready

5.0

7.0

不适用

sphinx.io.read_doc()

5.0

7.0

sphinx.builders.Builder.read_doc()

sphinx.util.docutils.__version_info__

5.0

7.0

docutils.__version_info__

sphinx.util.docutils.is_html5_writer_available()

5.0

7.0

不适用

sphinx.writers.latex.LaTeXWriter.docclasses

5.0

7.0

不适用

sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()

4.5

6.0

不适用

sphinx.ext.autodoc.AttributeDocumenter._datadescriptor

4.3

6.0

不适用

sphinx.writers.html.HTMLTranslator._fieldlist_row_index

4.3

6.0

sphinx.writers.html.HTMLTranslator._fieldlist_row_indices

sphinx.writers.html.HTMLTranslator._table_row_index

4.3

6.0

sphinx.writers.html.HTMLTranslator._table_row_indices

sphinx.writers.html5.HTML5Translator._fieldlist_row_index

4.3

6.0

sphinx.writers.html5.HTML5Translator._fieldlist_row_indices

sphinx.writers.html5.HTML5Translator._table_row_index

4.3

6.0

sphinx.writers.html5.HTML5Translator._table_row_indices

sphinx.environment.BuildEnvironment 的可选参数 app

4.1

6.0

所需参数

sphinx.application.Sphinx.html_theme

4.1

6.0

sphinx.registry.SphinxComponentRegistry.html_themes

sphinx.ext.autosummary._app

4.1

6.0

不适用

sphinx.util.docstrings.extract_metadata()

4.1

6.0

sphinx.util.docstrings.separate_metadata()

HTML 模板中的 favicon 变量

4.0

6.0

favicon_url

HTML 模板中的 logo 变量

4.0

6.0

logo_url

sphinx.directives.patches.ListTable

4.0

6.0

docutils.parsers.rst.directives.tables.ListSVTable

sphinx.directives.patches.RSTTable

4.0

6.0

docutils.parsers.rst.directives.tables.RSTTable

sphinx.ext.autodoc.directive.DocumenterBridge.filename_set

4.0

6.0

sphinx.ext.autodoc.directive.DocumenterBridge.record_dependencies

sphinx.ext.autodoc.directive.DocumenterBridge.warn()

4.0

6.0

日志 API

sphinx.registry.SphinxComponentRegistry.get_source_input()

4.0

6.0

不适用

sphinx.registry.SphinxComponentRegistry.source_inputs

4.0

6.0

不适用

sphinx.transforms.FigureAligner

4.0

6.0

不适用

sphinx.util.pycompat.convert_with_2to3()

4.0

6.0

不适用

sphinx.util.pycompat.execfile_()

4.0

6.0

不适用

sphinx.util.smartypants

4.0

6.0

docutils.utils.smartquotes

sphinx.util.typing.DirectiveOption

4.0

6.0

不适用

viewcode 扩展的 pending_xref 节点

3.5

5.0

sphinx.ext.viewcode.viewcode_anchor

sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore

3.5

5.0

不适用

sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth

3.5

5.0

不适用

sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken

3.5

5.0

不适用

sphinx.builders.linkcheck.CheckExternalLinksBuilder.good

3.5

5.0

不适用

sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected

3.5

5.0

不适用

sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue

3.5

5.0

不适用

sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore

3.5

5.0

不适用

sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers

3.5

5.0

不适用

sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue

3.5

5.0

不适用

sphinx.builders.linkcheck.node_line_or_0()

3.5

5.0

sphinx.util.nodes.get_node_line()

sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()

3.5

5.0

不适用

sphinx.ext.autodoc.importer.get_module_members()

3.5

5.0

sphinx.ext.autodoc.ModuleDocumenter.get_module_members()

sphinx.ext.autosummary.generate._simple_info()

3.5

5.0

日志 API

sphinx.ext.autosummary.generate._simple_warn()

3.5

5.0

日志 API

sphinx.writers.html.HTMLTranslator.permalink_text

3.5

5.0

html_永久链接_图标

sphinx.writers.html5.HTML5Translator.permalink_text

3.5

5.0

html_永久链接_图标

sphinx.util.inspect.signature()follow_wrapped 参数

3.4

5.0

不适用

sphinx.ext.autodoc.Documenter.add_content()no_docstring 参数

3.4

5.0

sphinx.ext.autodoc.Documenter.get_doc()

sphinx.ext.autodoc.Documenter.get_object_members()

3.4

6.0

sphinx.ext.autodoc.ClassDocumenter.get_object_members()

sphinx.ext.autodoc.DataDeclarationDocumenter

3.4

5.0

sphinx.ext.autodoc.DataDocumenter

sphinx.ext.autodoc.GenericAliasDocumenter

3.4

5.0

sphinx.ext.autodoc.DataDocumenter

sphinx.ext.autodoc.InstanceAttributeDocumenter

3.4

5.0

sphinx.ext.autodoc.AttributeDocumenter

sphinx.ext.autodoc.SlotsAttributeDocumenter

3.4

5.0

sphinx.ext.autodoc.AttributeDocumenter

sphinx.ext.autodoc.TypeVarDocumenter

3.4

5.0

sphinx.ext.autodoc.DataDocumenter

sphinx.ext.autodoc.directive.DocumenterBridge.reporter

3.5

5.0

sphinx.util.logging

sphinx.ext.autodoc.importer._getannotations()

3.4

4.0

sphinx.util.inspect.getannotations()

sphinx.ext.autodoc.importer._getmro()

3.4

4.0

sphinx.util.inspect.getmro()

sphinx.pycode.ModuleAnalyzer.parse()

3.4

5.0

sphinx.pycode.ModuleAnalyzer.analyze()

sphinx.util.osutil.movefile()

3.4

5.0

os.replace()

sphinx.util.requests.is_ssl_error()

3.4

5.0

不适用

sphinx.builders.latex.LaTeXBuilder.usepackages

3.3

5.0

不适用

sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref

3.3

5.0

不适用

sphinx.ext.autodoc.SingledispatchFunctionDocumenter

3.3

5.0

sphinx.ext.autodoc.FunctionDocumenter

sphinx.ext.autodoc.SingledispatchMethodDocumenter

3.3

5.0

sphinx.ext.autodoc.MethodDocumenter

sphinx.ext.autodoc.members_set_option()

3.2

5.0

不适用

sphinx.ext.autodoc.merge_special_members_option()

3.2

5.0

sphinx.ext.autodoc.merge_members_option()

sphinx.writers.texinfo.TexinfoWriter.desc

3.2

5.0

sphinx.writers.texinfo.TexinfoWriter.descs

sphinx.ext.autosummary.generate.AutosummaryRenderer 的第一个参数已更改为 Sphinx 对象

3.1

5.0

不适用

sphinx.ext.autosummary.generate.AutosummaryRenderer 将对象类型作为参数

3.1

5.0

不适用

sphinx.ext.autodoc.Documenter.get_doc()ignore 参数

3.1

5.0

不适用

sphinx.ext.autosummary.generate.AutosummaryRenderertemplate_dir 参数

3.1

5.0

不适用

sphinx.ext.autosummary.generate.find_autosummary_in_docstring()module 参数

3.0

5.0

不适用

sphinx.ext.autosummary.generate.generate_autosummary_docs()builder 参数

3.1

5.0

不适用

sphinx.ext.autosummary.generate.generate_autosummary_docs()template_dir 参数

3.1

5.0

不适用

sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()

3.1

5.0

不适用

sphinx.util.docstring.prepare_docstring()ignore 参数

3.1

5.0

不适用

sphinx.util.rpartition()

3.1

5.0

str.rpartition()

desc_signature['first']

3.0

不适用

sphinx.directives.DescDirective

3.0

5.0

sphinx.directives.ObjectDescription

sphinx.domains.std.StandardDomain.add_object()

3.0

5.0

sphinx.domains.std.StandardDomain.note_object()

sphinx.domains.python.PyDecoratorMixin

3.0

5.0

不适用

sphinx.ext.autodoc.get_documenters()

3.0

5.0

sphinx.registry.documenters

sphinx.ext.autosummary.process_autosummary_toc()

3.0

5.0

不适用

sphinx.parsers.Parser.app

3.0

5.0

不适用

sphinx.testing.path.Path.text()

3.0

5.0

sphinx.testing.path.Path.read_text()

sphinx.testing.path.Path.bytes()

3.0

5.0

sphinx.testing.path.Path.read_bytes()

sphinx.util.inspect.getargspec()

3.0

5.0

inspect.getargspec()

sphinx.writers.latex.LaTeXWriter.format_docclass()

3.0

5.0

LaTeX 主题

sphinx.pycode.ModuleAnalyzer()decode 参数

2.4

4.0

不适用

sphinx.directives.other.Index

2.4

4.0

sphinx.domains.index.IndexDirective

sphinx.environment.temp_data['gloss_entries']

2.4

4.0

documents.nameids

sphinx.environment.BuildEnvironment.indexentries

2.4

4.0

sphinx.domains.index.IndexDomain

sphinx.environment.collectors.indexentries.IndexEntriesCollector

2.4

4.0

sphinx.domains.index.IndexDomain

sphinx.io.FiletypeNotFoundError

2.4

4.0

sphinx.errors.FiletypeNotFoundError

sphinx.ext.apidoc.INITPY

2.4

4.0

不适用

sphinx.ext.apidoc.shall_skip()

2.4

4.0

sphinx.ext.apidoc.is_skipped_package

sphinx.io.get_filetype()

2.4

4.0

sphinx.util.get_filetype()

sphinx.pycode.ModuleAnalyzer.encoding

2.4

4.0

不适用

sphinx.roles.Index

2.4

4.0

sphinx.domains.index.IndexRole

sphinx.util.detect_encoding()

2.4

4.0

tokenize.detect_encoding()

sphinx.util.get_module_source()

2.4

4.0

不适用

sphinx.util.inspect.Signature

2.4

4.0

sphinx.util.inspect.signaturesphinx.util.inspect.stringify_signature()

sphinx.util.inspect.safe_getmembers()

2.4

4.0

inspect.getmembers()

sphinx.writers.latex.LaTeXTranslator.settings.author

2.4

4.0

不适用

sphinx.writers.latex.LaTeXTranslator.settings.contentsname

2.4

4.0

document['contentsname']

sphinx.writers.latex.LaTeXTranslator.settings.docclass

2.4

4.0

document['docclass']

sphinx.writers.latex.LaTeXTranslator.settings.docname

2.4

4.0

不适用

sphinx.writers.latex.LaTeXTranslator.settings.title

2.4

4.0

不适用

sphinx.writers.latex.ADDITIONAL_SETTINGS

2.4

4.0

sphinx.builders.latex.constants.ADDITIONAL_SETTINGS

sphinx.writers.latex.DEFAULT_SETTINGS

2.4

4.0

sphinx.builders.latex.constants.DEFAULT_SETTINGS

sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG

2.4

4.0

sphinx.builders.latex.constants.LUALATEX_DEFAULT_FONTPKG

sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG

2.4

4.0

sphinx.builders.latex.constants.PDFLATEX_DEFAULT_FONTPKG

sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG

2.4

4.0

sphinx.builders.latex.constants.XELATEX_DEFAULT_FONTPKG

sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG

2.4

4.0

sphinx.builders.latex.constants.XELATEX_GREEK_DEFAULT_FONTPKG

sphinx.builders.gettext.POHEADER

2.3

4.0

sphinx/templates/gettext/message.pot_t(模板文件)

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_map_new

2.3

4.0

sphinx.util.texescape.hlescape()

sphinx.writers.latex.LaTeXTranslator.no_contractions

2.3

4.0

不适用

sphinx.domains.math.MathDomain.add_equation()

2.2

4.0

sphinx.domains.math.MathDomain.note_equation()

sphinx.domains.math.MathDomain.get_next_equation_number()

2.2

4.0

sphinx.domains.math.MathDomain.note_equation()

sphinx.ext.autosummary.generate.generate_autosummary_docs()infowarn 参数

2.2

4.0

logging.info()logging.warning()

sphinx.ext.autosummary.generate._simple_info()

2.2

4.0

logging.info()

sphinx.ext.autosummary.generate._simple_warn()

2.2

4.0

logging.warning()

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.apply_transforms()

2.1

4.0

不适用

sphinx.builders._epub_base.EpubBuilder.esc()

2.1

4.0

html.escape()

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.domains.changeset.VersionChange

sphinx.domains.python.PyClassmember

2.1

4.0

sphinx.domains.python.PyAttributesphinx.domains.python.PyMethodsphinx.domains.python.PyClassMethodsphinx.domains.python.PyObjectsphinx.domains.python.PyStaticMethod

sphinx.domains.python.PyModulelevel

2.1

4.0

sphinx.domains.python.PyFunctionsphinx.domains.python.PyObjectsphinx.domains.python.PyVariable

sphinx.domains.std.StandardDomain._resolve_citation_xref()

2.1

4.0

sphinx.domains.citation.CitationDomain.resolve_xref()

sphinx.domains.std.StandardDomain.note_citations()

2.1

4.0

sphinx.domains.citation.CitationDomain.note_citation()

sphinx.domains.std.StandardDomain.note_citation_refs()

2.1

4.0

sphinx.domains.citation.CitationDomain.note_citation_reference()

sphinx.domains.std.StandardDomain.note_labels()

2.1

4.0

sphinx.domains.std.StandardDomain.process_doc()

sphinx.domains.js.JSObject.display_prefix

4.3

sphinx.domains.js.JSObject.get_display_prefix()

sphinx.environment.NoUri

2.1

3.0

sphinx.errors.NoUri

sphinx.ext.apidoc.format_directive()

2.1

4.0

不适用

sphinx.ext.apidoc.format_heading()

2.1

4.0

不适用

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

不适用

sphinx.ext.imgmath.DOC_BODY_PREVIEW

2.1

4.0

不适用

sphinx.ext.imgmath.DOC_HEAD

2.1

4.0

不适用

sphinx.transforms.CitationReferences

2.1

4.0

sphinx.domains.citation.CitationReferenceTransform

sphinx.transforms.SmartQuotesSkipper

2.1

4.0

sphinx.domains.citation.CitationDefinitionTransform

sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()

2.1

4.0

sphinx.directives.ObjectDescription.get_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_files()

2.1

4.0

sphinx.util.i18n.CatalogRepository

autodoc.Documenter.get_doc()autodoc.DocstringSignatureMixin.get_doc()autodoc.DocstringSignatureMixin._find_signature()autodoc.ClassDocumenter.get_doc()encoding 参数

2.0

4.0

不适用

EpubBuilder.build_mimetype()EpubBuilder.build_container()EpubBuilder.build_content()EpubBuilder.build_toc()EpubBuilder.build_epub() 的参数

2.0

4.0

不适用

Epub3Builder.build_navigation_doc() 的参数

2.0

4.0

不适用

sphinx.search.WordCollector.is_meta_keywords()nodetype 参数

2.0

4.0

不适用

BuildEnvironment.doc2path()suffix 参数

2.0

4.0

不适用

BuildEnvironment.doc2path() 的字符串样式 base 参数

2.0

4.0

os.path.join()

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.validate_config_value()

2.0

4.0

sphinx.builders.epub3.validate_config_values()

sphinx.builders.html.JSONHTMLBuilder

2.0

4.0

sphinx.builders.serializinghtml.JSONHTMLBuilder

sphinx.builders.html.PickleHTMLBuilder

2.0

4.0

sphinx.builders.serializinghtml.PickleHTMLBuilder

sphinx.builders.html.SerializingHTMLBuilder

2.0

4.0

sphinx.builders.serializinghtml.SerializingHTMLBuilder

sphinx.builders.html.SingleFileHTMLBuilder

2.0

4.0

sphinx.builders.singlehtml.SingleFileHTMLBuilder

sphinx.builders.html.WebHTMLBuilder

2.0

4.0

sphinx.builders.serializinghtml.PickleHTMLBuilder

sphinx.builders.htmlhelp

2.0

4.0

sphinxcontrib.htmlhelp

sphinx.builders.htmlhelp.HTMLHelpBuilder.open_file()

2.0

4.0

open()

sphinx.builders.qthelp

2.0

4.0

sphinxcontrib.qthelp

sphinx.cmd.quickstart.term_decode()

2.0

4.0

不适用

sphinx.cmd.quickstart.TERM_ENCODING

2.0

4.0

sys.stdin.encoding

sphinx.config.check_unicode()

2.0

4.0

不适用

sphinx.config.string_classes

2.0

4.0

[str]

sphinx.domains.cpp.DefinitionError.description

2.0

4.0

str(exc)

sphinx.domains.cpp.NoOldIdError.description

2.0

4.0

str(exc)

sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decoded

2.0

4.0

str(exc)

sphinx.ext.autosummary.Autosummary.warn()

2.0

4.0

不适用

sphinx.ext.autosummary.Autosummary.genopt

2.0

4.0

不适用

sphinx.ext.autosummary.Autosummary.warnings

2.0

4.0

不适用

sphinx.ext.autosummary.Autosummary.result

2.0

4.0

不适用

sphinx.ext.doctest.doctest_encode()

2.0

4.0

不适用

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.GUILabelsphinx.roles.MenuSelection

sphinx.roles.index_role()

2.0

4.0

sphinx.roles.Index

sphinx.roles.indexmarkup_role()

2.0

4.0

sphinx.roles.PEPsphinx.roles.RFC

sphinx.testing.util.remove_unicode_literal()

2.0

4.0

不适用

sphinx.util.attrdict

2.0

4.0

不适用

sphinx.util.force_decode()

2.0

5.0

不适用

sphinx.util.get_matching_docs()

2.0

4.0

sphinx.util.get_matching_files()

sphinx.util.inspect.Parameter

2.0

3.0

不适用

sphinx.util.jsonimpl

2.0

4.0

sphinxcontrib.serializinghtml.jsonimpl

sphinx.util.osutil.EEXIST

2.0

4.0

errno.EEXISTFileExistsError

sphinx.util.osutil.EINVAL

2.0

4.0

errno.EINVAL

sphinx.util.osutil.ENOENT

2.0

4.0

errno.ENOENTFileNotFoundError

sphinx.util.osutil.EPIPE

2.0

4.0

errno.ENOENTBrokenPipeError

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

不适用

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

不适用

sphinx.util.PeekableIterator

2.0

4.0

不适用

在重写的 IndexBuilder.feed() 方法中省略 filename 参数。

2.0

4.0

IndexBuilder.feed(docname, filename, title, doctree)

sphinx.writers.latex.ExtBabel

2.0

4.0

sphinx.builders.latex.util.ExtBabel

sphinx.writers.latex.LaTeXTranslator.babel_defmacro()

2.0

4.0

不适用

sphinx.application.Sphinx._setting_up_extension

2.0

3.0

不适用

sphinx.ext.autodoc.importer._MockModuleimporter 参数

2.0

3.0

不适用

sphinx.ext.autodoc.importer._MockImporter

2.0

3.0

不适用

sphinx.io.SphinxBaseFileInput

2.0

3.0

不适用

sphinx.io.SphinxFileInput.supported

2.0

3.0

不适用

sphinx.io.SphinxRSTFileInput

2.0

3.0

不适用

sphinx.registry.SphinxComponentRegistry.add_source_input()

2.0

3.0

不适用

sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()

2.0

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.collect_footnotes()

2.0

4.0

不适用

sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()

2.0

3.0

不适用

sphinx.writers.text.TextTranslator._make_depart_admonition()

2.0

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()

2.0

4.0

不适用

highlightlang

1.8

4.0

highlight

add_stylesheet()

1.8

6.0

add_css_file()

add_javascript()

1.8

4.0

add_js_file()

autodoc_default_flags

1.8

4.0

autodoc_default_options

sphinx.util.image.guess_mimetype()content 参数

1.8

3.0

不适用

sphinx.util.i18n.find_catalog_source_files()gettext_compact 参数

1.8

3.0

不适用

sphinx.io.SphinxI18nReader.set_lineno_for_reporter()

1.8

3.0

不适用

sphinx.io.SphinxI18nReader.line

1.8

3.0

不适用

sphinx.directives.other.VersionChange

1.8

3.0

sphinx.domains.changeset.VersionChange

sphinx.highlighting.PygmentsBridge.unhighlight()

1.8

3.0

不适用

sphinx.highlighting.PygmentsBridgetrim_doctest_flags 参数

1.8

3.0

不适用

sphinx.ext.mathbase

1.8

3.0

不适用

sphinx.ext.mathbase.MathDomain

1.8

3.0

sphinx.domains.math.MathDomain

sphinx.ext.mathbase.MathDirective

1.8

3.0

sphinx.directives.patches.MathDirective

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_title()

1.8

3.0

不适用

sphinx.ext.mathbase.get_node_equation_number()

1.8

3.0

sphinx.util.math.get_node_equation_number()

sphinx.ext.mathbase.wrap_displaymath()

1.8

3.0

sphinx.util.math.wrap_displaymath()

sphinx.ext.mathbase.math(节点)

1.8

3.0

docutils.nodes.math

sphinx.ext.mathbase.displaymath(节点)

1.8

3.0

docutils.nodes.math_block

sphinx.ext.mathbase.eqref(节点)

1.8

3.0

sphinx.builders.latex.nodes.math_reference

viewcode_import(配置值)

1.8

3.0

viewcode_follow_imported_members

sphinx.writers.latex.Table.caption_footnotetexts

1.8

3.0

不适用

sphinx.writers.latex.Table.header_footnotetexts

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.footnotestack

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.in_container_literal_block

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.next_section_ids

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.restrict_footnote()

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.bibitems

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.hlsettingstack

1.8

3.0

不适用

sphinx.writers.latex.ExtBabel.get_shorthandoff()

1.8

3.0

不适用

sphinx.writers.html.HTMLTranslator.highlightlang()

1.8

3.0

不适用

sphinx.writers.html.HTMLTranslator.highlightlang_base()

1.8

3.0

不适用

sphinx.writers.html.HTMLTranslator.highlightlangopts()

1.8

3.0

不适用

sphinx.writers.html.HTMLTranslator.highlightlinenothreshold()

1.8

3.0

不适用

sphinx.writers.html5.HTMLTranslator.highlightlang()

1.8

3.0

不适用

sphinx.writers.html5.HTMLTranslator.highlightlang_base()

1.8

3.0

不适用

sphinx.writers.html5.HTMLTranslator.highlightlangopts()

1.8

3.0

不适用

sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold()

1.8

3.0

不适用

sphinx.writers.latex.LaTeXTranslator.check_latex_elements()

1.8

3.0

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()

Config.__init__()dirnamefilenametags 参数

1.8

3.0

Config.read()

html_search_options 的值

1.8

3.0

请参阅 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()

add_source_parser()suffix 参数

1.8

3.0

add_source_suffix()

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

吹毛求疵_忽略

BuildEnvironment.versionchanges

1.8

3.0

不适用

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()(模板辅助函数)

1.8

3.0

warning()

source_parsers

1.8

3.0

add_source_parser()

sphinx.util.docutils.directive_helper()

1.8

3.0

docutils 的 Directive

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_input()

sphinx.ext.autodoc.add_documenter()

1.7

2.0

add_autodocumenter()

sphinx.ext.autodoc.AutoDirective._register

1.7

2.0

add_autodocumenter()

AutoDirective._special_attrgetters

1.7

2.0

add_autodoc_attrgetter()

Sphinx.warn()Sphinx.info()

1.6

2.0

日志 API

BuildEnvironment.set_warnfunc()

1.6

2.0

日志 API

BuildEnvironment.note_toctree()

1.6

2.0

Toctree.note()(在 sphinx.environment.adapters.toctree 中)

BuildEnvironment.get_toc_for()

1.6

2.0

Toctree.get_toc_for()(在 sphinx.environment.adapters.toctree 中)

BuildEnvironment.get_toctree_for()

1.6

2.0

Toctree.get_toctree_for()(在 sphinx.environment.adapters.toctree 中)

BuildEnvironment.create_index()

1.6

2.0

IndexEntries.create_index()(在 sphinx.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_紧凑

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__

注意

在弃用公共 API(内部函数和类)时,我们也尽可能遵循此策略。