doc/extdev/deprecated.rst
.. _dev-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 :ref:deprecation-policy).
The following is a list of deprecated interfaces.
.. tabularcolumns:: >{\raggedright}\Y{.4}>{\centering}\Y{.1}>{\sphinxcolorblend{!95!red}\centering\noindent\bfseries\color{red}}\Y{.12}>{\raggedright\arraybackslash}\Y{.38}
.. list-table:: deprecated APIs :header-rows: 1 :class: deprecated :widths: 40, 10, 10, 40
sphinx.io (entire module)docutils.io or standard Python I/Osphinx.builders.Builder.appsphinx.environment.BuildEnvironment.appsphinx.transforms.Transform.appsphinx.transforms.post_transforms.SphinxPostTransform.appsphinx.events.EventManager.appsphinx.builders.singlehtml.SingleFileHTMLBuilder.fix_refurissphinx.util.FilenameUniqDictsphinx.util.DownloadFilessphinx.ext.intersphinx.normalize_intersphinx_mappingsphinx.ext.intersphinx.validate_intersphinx_mappingsphinx.testing.util.strip_escseqsphinx.util.console.strip_colorsOld-style Makefiles in sphinx-quickstart
and the :option:!-M, :option:!-m, :option:!--no-use-make-mode,
and :option:!--use-make-mode options
7.3
9.0
Vendoring the old style Makefile templates__
__ https://github.com/sphinx-doc/sphinx/blob/v7.0.0/sphinx/templates/quickstart/Makefile_t
sphinx.ext.autodoc.preserve_defaults.get_function_def()sphinx.builders.html.StandaloneHTMLBuilder.css_filessphinx.builders.html.StandaloneHTMLBuilder.script_filessphinx.builders.html.Stylesheetsphinx.application.Sphinx.add_css_file()sphinx.builders.html.JavaScriptsphinx.application.Sphinx.add_js_file()sphinx.util.split_intosphinx.util.split_index_msgsphinx.util.index_entries.split_index_msgsphinx.testing.pathos.path or pathlibsphinx.util.md5hashlib.md5sphinx.util.sha1hashlib.sha1sphinx.util.osutil.cdcontextlib.chdirsphinx.util.save_tracebacksphinx.util.exceptions.save_tracebacksphinx.util.format_exception_cut_framessphinx.util.exceptions.format_exception_cut_framessphinx.util.epoch_to_rfc1123sphinx.util.http_date.epoch_to_rfc1123sphinx.util.rfc1123_to_epochsphinx.util.http_date.rfc1123_to_epochsphinx.util.status_iteratorsphinx.util.display.status_iteratorsphinx.util.display_chunksphinx.util.display.display_chunksphinx.util.SkipProgressMessagesphinx.util.display.SkipProgressMessagesphinx.util.progress_messagesphinx.util.display.progress_messagesphinx.util.typing.stringifysphinx.util.typing.stringify_annotationsphinx.util.path_stabilizesphinx.util.osutil.path_stabilizesphinx.util.get_matching_filessphinx.util.matching.get_matching_filessphinx.ext.napoleon.iteratorspockets.iteratorssphinx.util.stemmersnowballstemmersphinx.util.jsdumpjson module.setup.py build_sphinx)locale argument of sphinx.util.i18n:babel_format_date()language argument of sphinx.util.i18n:format_date()sphinx.builders.html.html5_readysphinx.io.read_doc()sphinx.builders.Builder.read_doc()sphinx.util.docutils.__version_info__docutils.__version_info__sphinx.util.docutils.is_html5_writer_available()sphinx.writers.latex.LaTeXWriter.docclassessphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()sphinx.ext.autodoc.AttributeDocumenter._datadescriptorsphinx.writers.html.HTMLTranslator._fieldlist_row_indexsphinx.writers.html.HTMLTranslator._fieldlist_row_indicessphinx.writers.html.HTMLTranslator._table_row_indexsphinx.writers.html.HTMLTranslator._table_row_indicessphinx.writers.html5.HTML5Translator._fieldlist_row_indexsphinx.writers.html5.HTML5Translator._fieldlist_row_indicessphinx.writers.html5.HTML5Translator._table_row_indexsphinx.writers.html5.HTML5Translator._table_row_indicesapp for sphinx.environment.BuildEnvironmentsphinx.application.Sphinx.html_themesphinx.registry.SphinxComponentRegistry.html_themessphinx.ext.autosummary._appsphinx.util.docstrings.extract_metadata()sphinx.util.docstrings.separate_metadata()favicon variable in HTML templatesfavicon_urllogo variable in HTML templateslogo_urlsphinx.directives.patches.ListTabledocutils.parsers.rst.directives.tables.ListSVTablesphinx.directives.patches.RSTTabledocutils.parsers.rst.directives.tables.RSTTablesphinx.ext.autodoc.directive.DocumenterBridge.filename_setsphinx.ext.autodoc.directive.DocumenterBridge.record_dependenciessphinx.ext.autodoc.directive.DocumenterBridge.warn()logging-apisphinx.registry.SphinxComponentRegistry.get_source_input()sphinx.registry.SphinxComponentRegistry.source_inputssphinx.transforms.FigureAlignersphinx.util.pycompat.convert_with_2to3()sphinx.util.pycompat.execfile_()sphinx.util.smartypantsdocutils.utils.smartquotessphinx.util.typing.DirectiveOptionsphinx.ext.viewcode.viewcode_anchorsphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignoresphinx.builders.linkcheck.CheckExternalLinksBuilder.authsphinx.builders.linkcheck.CheckExternalLinksBuilder.brokensphinx.builders.linkcheck.CheckExternalLinksBuilder.goodsphinx.builders.linkcheck.CheckExternalLinksBuilder.redirectedsphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueuesphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignoresphinx.builders.linkcheck.CheckExternalLinksBuilder.workerssphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueuesphinx.builders.linkcheck.node_line_or_0()sphinx.util.nodes.get_node_line()sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()sphinx.ext.autodoc.importer.get_module_members()sphinx.ext.autodoc.ModuleDocumenter.get_module_members()sphinx.ext.autosummary.generate._simple_info()logging-apisphinx.ext.autosummary.generate._simple_warn()logging-apisphinx.writers.html.HTMLTranslator.permalink_texthtml_permalinks_iconsphinx.writers.html5.HTML5Translator.permalink_texthtml_permalinks_iconfollow_wrapped argument of sphinx.util.inspect.signature()no_docstring argument of
sphinx.ext.autodoc.Documenter.add_content()sphinx.ext.autodoc.Documenter.get_doc()sphinx.ext.autodoc.Documenter.get_object_members()sphinx.ext.autodoc.ClassDocumenter.get_object_members()sphinx.ext.autodoc.DataDeclarationDocumentersphinx.ext.autodoc.DataDocumentersphinx.ext.autodoc.GenericAliasDocumentersphinx.ext.autodoc.DataDocumentersphinx.ext.autodoc.InstanceAttributeDocumentersphinx.ext.autodoc.AttributeDocumentersphinx.ext.autodoc.SlotsAttributeDocumentersphinx.ext.autodoc.AttributeDocumentersphinx.ext.autodoc.TypeVarDocumentersphinx.ext.autodoc.DataDocumentersphinx.ext.autodoc.directive.DocumenterBridge.reportersphinx.util.loggingsphinx.ext.autodoc.importer._getannotations()sphinx.util.inspect.getannotations()sphinx.ext.autodoc.importer._getmro()sphinx.util.inspect.getmro()sphinx.pycode.ModuleAnalyzer.parse()sphinx.pycode.ModuleAnalyzer.analyze()sphinx.util.osutil.movefile()os.replace()sphinx.util.requests.is_ssl_error()sphinx.builders.latex.LaTeXBuilder.usepackagessphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperrefsphinx.ext.autodoc.SingledispatchFunctionDocumentersphinx.ext.autodoc.FunctionDocumentersphinx.ext.autodoc.SingledispatchMethodDocumentersphinx.ext.autodoc.MethodDocumentersphinx.ext.autodoc.members_set_option()sphinx.ext.autodoc.merge_special_members_option()sphinx.ext.autodoc.merge_members_option()sphinx.writers.texinfo.TexinfoWriter.descsphinx.writers.texinfo.TexinfoWriter.descssphinx.ext.autosummary.generate.AutosummaryRenderer has been changed
to Sphinx objectsphinx.ext.autosummary.generate.AutosummaryRenderer takes an object
type as an argumentignore argument of sphinx.ext.autodoc.Documenter.get_doc()template_dir argument of
sphinx.ext.autosummary.generate.AutosummaryRenderermodule argument of
sphinx.ext.autosummary.generate.find_autosummary_in_docstring()builder argument of
sphinx.ext.autosummary.generate.generate_autosummary_docs()template_dir argument of
sphinx.ext.autosummary.generate.generate_autosummary_docs()sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()ignore argument of sphinx.util.docstring.prepare_docstring()sphinx.util.rpartition()str.rpartition()desc_signature['first']sphinx.directives.DescDirectivesphinx.directives.ObjectDescriptionsphinx.domains.std.StandardDomain.add_object()sphinx.domains.std.StandardDomain.note_object()sphinx.domains.python.PyDecoratorMixinsphinx.ext.autodoc.get_documenters()sphinx.registry.documenterssphinx.ext.autosummary.process_autosummary_toc()sphinx.parsers.Parser.appsphinx.testing.path.Path.text()sphinx.testing.path.Path.read_text()sphinx.testing.path.Path.bytes()sphinx.testing.path.Path.read_bytes()sphinx.util.inspect.getargspec()inspect.getargspec()sphinx.writers.latex.LaTeXWriter.format_docclass()decode argument of sphinx.pycode.ModuleAnalyzer()sphinx.directives.other.Indexsphinx.domains.index.IndexDirectivesphinx.environment.temp_data['gloss_entries']documents.nameidssphinx.environment.BuildEnvironment.indexentriessphinx.domains.index.IndexDomainsphinx.environment.collectors.indexentries.IndexEntriesCollectorsphinx.domains.index.IndexDomainsphinx.io.FiletypeNotFoundErrorsphinx.errors.FiletypeNotFoundErrorsphinx.ext.apidoc.INITPYsphinx.ext.apidoc.shall_skip()sphinx.ext.apidoc.is_skipped_packagesphinx.io.get_filetype()sphinx.util.get_filetype()sphinx.pycode.ModuleAnalyzer.encodingsphinx.roles.Indexsphinx.domains.index.IndexRolesphinx.util.detect_encoding()tokenize.detect_encoding()sphinx.util.get_module_source()sphinx.util.inspect.Signaturesphinx.util.inspect.signature and
sphinx.util.inspect.stringify_signature()sphinx.util.inspect.safe_getmembers()inspect.getmembers()sphinx.writers.latex.LaTeXTranslator.settings.authorsphinx.writers.latex.LaTeXTranslator.settings.contentsnamedocument['contentsname']sphinx.writers.latex.LaTeXTranslator.settings.docclassdocument['docclass']sphinx.writers.latex.LaTeXTranslator.settings.docnamesphinx.writers.latex.LaTeXTranslator.settings.titlesphinx.writers.latex.ADDITIONAL_SETTINGSsphinx.builders.latex.constants.ADDITIONAL_SETTINGSsphinx.writers.latex.DEFAULT_SETTINGSsphinx.builders.latex.constants.DEFAULT_SETTINGSsphinx.writers.latex.LUALATEX_DEFAULT_FONTPKGsphinx.builders.latex.constants.LUALATEX_DEFAULT_FONTPKGsphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKGsphinx.builders.latex.constants.PDFLATEX_DEFAULT_FONTPKGsphinx.writers.latex.XELATEX_DEFAULT_FONTPKGsphinx.builders.latex.constants.XELATEX_DEFAULT_FONTPKGsphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKGsphinx.builders.latex.constants.XELATEX_GREEK_DEFAULT_FONTPKGsphinx.builders.gettext.POHEADERsphinx/templates/gettext/message.pot_t (template file)sphinx.io.SphinxStandaloneReader.appsphinx.io.SphinxStandaloneReader.setup()sphinx.io.SphinxStandaloneReader.envsphinx.io.SphinxStandaloneReader.setup()sphinx.util.texescape.tex_escape_mapsphinx.util.texescape.escape()sphinx.util.texescape.tex_hl_escape_map_newsphinx.util.texescape.hlescape()sphinx.writers.latex.LaTeXTranslator.no_contractionssphinx.domains.math.MathDomain.add_equation()sphinx.domains.math.MathDomain.note_equation()sphinx.domains.math.MathDomain.get_next_equation_number()sphinx.domains.math.MathDomain.note_equation()info and warn arguments of
sphinx.ext.autosummary.generate.generate_autosummary_docs()logging.info() and logging.warning()sphinx.ext.autosummary.generate._simple_info()logging.info()sphinx.ext.autosummary.generate._simple_warn()logging.warning()sphinx.ext.todo.merge_info()sphinx.ext.todo.TodoDomainsphinx.ext.todo.process_todo_nodes()sphinx.ext.todo.TodoDomainsphinx.ext.todo.process_todos()sphinx.ext.todo.TodoDomainsphinx.ext.todo.purge_todos()sphinx.ext.todo.TodoDomainsphinx.builders.latex.LaTeXBuilder.apply_transforms()sphinx.builders._epub_base.EpubBuilder.esc()html.escape()sphinx.directives.Ackssphinx.directives.other.Ackssphinx.directives.Authorsphinx.directives.other.Authorsphinx.directives.Centeredsphinx.directives.other.Centeredsphinx.directives.Classsphinx.directives.other.Classsphinx.directives.CodeBlocksphinx.directives.code.CodeBlocksphinx.directives.Figuresphinx.directives.patches.Figuresphinx.directives.HListsphinx.directives.other.HListsphinx.directives.Highlightsphinx.directives.code.Highlightsphinx.directives.Includesphinx.directives.other.Includesphinx.directives.Indexsphinx.directives.other.Indexsphinx.directives.LiteralIncludesphinx.directives.code.LiteralIncludesphinx.directives.Metasphinx.directives.patches.Metasphinx.directives.Onlysphinx.directives.other.Onlysphinx.directives.SeeAlsosphinx.directives.other.SeeAlsosphinx.directives.TabularColumnssphinx.directives.other.TabularColumnssphinx.directives.TocTreesphinx.directives.other.TocTreesphinx.directives.VersionChangesphinx.domains.changeset.VersionChangesphinx.domains.python.PyClassmembersphinx.domains.python.PyAttribute,
sphinx.domains.python.PyMethod,
sphinx.domains.python.PyClassMethod,
sphinx.domains.python.PyObject and
sphinx.domains.python.PyStaticMethodsphinx.domains.python.PyModulelevelsphinx.domains.python.PyFunction,
sphinx.domains.python.PyObject and
sphinx.domains.python.PyVariablesphinx.domains.std.StandardDomain._resolve_citation_xref()sphinx.domains.citation.CitationDomain.resolve_xref()sphinx.domains.std.StandardDomain.note_citations()sphinx.domains.citation.CitationDomain.note_citation()sphinx.domains.std.StandardDomain.note_citation_refs()sphinx.domains.citation.CitationDomain.note_citation_reference()sphinx.domains.std.StandardDomain.note_labels()sphinx.domains.std.StandardDomain.process_doc()sphinx.domains.js.JSObject.display_prefixsphinx.domains.js.JSObject.get_display_prefix()sphinx.environment.NoUrisphinx.errors.NoUrisphinx.ext.apidoc.format_directive()sphinx.ext.apidoc.format_heading()sphinx.ext.apidoc.makename()sphinx.ext.apidoc.module_join()sphinx.ext.autodoc.importer.MockFindersphinx.ext.autodoc.mock.MockFindersphinx.ext.autodoc.importer.MockLoadersphinx.ext.autodoc.mock.MockLoadersphinx.ext.autodoc.importer.mock()sphinx.ext.autodoc.mock.mock()sphinx.ext.autosummary.autolink_role()sphinx.ext.autosummary.AutoLinksphinx.ext.imgmath.DOC_BODYsphinx.ext.imgmath.DOC_BODY_PREVIEWsphinx.ext.imgmath.DOC_HEADsphinx.transforms.CitationReferencessphinx.domains.citation.CitationReferenceTransformsphinx.transforms.SmartQuotesSkippersphinx.domains.citation.CitationDefinitionTransformsphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()sphinx.directives.ObjectDescription.get_field_type_map()sphinx.util.node.find_source_node()sphinx.util.node.get_node_source()sphinx.util.i18n.find_catalog()sphinx.util.i18n.docname_to_domain()sphinx.util.i18n.find_catalog_files()sphinx.util.i18n.CatalogRepositorysphinx.util.i18n.find_catalog_source_files()sphinx.util.i18n.CatalogRepositoryencoding argument of autodoc.Documenter.get_doc(),
autodoc.DocstringSignatureMixin.get_doc(),
autodoc.DocstringSignatureMixin._find_signature(), and
autodoc.ClassDocumenter.get_doc()EpubBuilder.build_mimetype(),
EpubBuilder.build_container(), EpubBuilder.build_content(),
EpubBuilder.build_toc() and EpubBuilder.build_epub()Epub3Builder.build_navigation_doc()nodetype argument of
sphinx.search.WordCollector.is_meta_keywords()suffix argument of BuildEnvironment.doc2path()base argument of BuildEnvironment.doc2path()os.path.join()sphinx.addnodes.abbreviationdocutils.nodes.abbreviationsphinx.builders.applehelpsphinxcontrib.applehelpsphinx.builders.devhelpsphinxcontrib.devhelpsphinx.builders.epub3.Epub3Builder.validate_config_value()sphinx.builders.epub3.validate_config_values()sphinx.builders.html.JSONHTMLBuildersphinx.builders.serializinghtml.JSONHTMLBuildersphinx.builders.html.PickleHTMLBuildersphinx.builders.serializinghtml.PickleHTMLBuildersphinx.builders.html.SerializingHTMLBuildersphinx.builders.serializinghtml.SerializingHTMLBuildersphinx.builders.html.SingleFileHTMLBuildersphinx.builders.singlehtml.SingleFileHTMLBuildersphinx.builders.html.WebHTMLBuildersphinx.builders.serializinghtml.PickleHTMLBuildersphinx.builders.htmlhelpsphinxcontrib.htmlhelpsphinx.builders.htmlhelp.HTMLHelpBuilder.open_file()open()sphinx.builders.qthelpsphinxcontrib.qthelpsphinx.cmd.quickstart.term_decode()sphinx.cmd.quickstart.TERM_ENCODINGsys.stdin.encodingsphinx.config.check_unicode()sphinx.config.string_classes[str]sphinx.domains.cpp.DefinitionError.descriptionstr(exc)sphinx.domains.cpp.NoOldIdError.descriptionstr(exc)sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decodedstr(exc)sphinx.ext.autosummary.Autosummary.warn()sphinx.ext.autosummary.Autosummary.genoptsphinx.ext.autosummary.Autosummary.warningssphinx.ext.autosummary.Autosummary.resultsphinx.ext.doctest.doctest_encode()sphinx.ext.jsmathsphinxcontrib.jsmathsphinx.roles.abbr_role()sphinx.roles.Abbreviationsphinx.roles.emph_literal_role()sphinx.roles.EmphasizedLiteralsphinx.roles.menusel_role()sphinx.roles.GUILabel or sphinx.roles.MenuSelectionsphinx.roles.index_role()sphinx.roles.Indexsphinx.roles.indexmarkup_role()sphinx.roles.PEP or sphinx.roles.RFCsphinx.testing.util.remove_unicode_literal()sphinx.util.attrdictsphinx.util.force_decode()sphinx.util.get_matching_docs()sphinx.util.get_matching_files()sphinx.util.inspect.Parametersphinx.util.jsonimplsphinxcontrib.serializinghtml.jsonimplsphinx.util.osutil.EEXISTerrno.EEXIST or FileExistsErrorsphinx.util.osutil.EINVALerrno.EINVALsphinx.util.osutil.ENOENTerrno.ENOENT or FileNotFoundErrorsphinx.util.osutil.EPIPEerrno.ENOENT or BrokenPipeErrorsphinx.util.osutil.walk()os.walk()sphinx.util.pycompat.NoneTypesphinx.util.typing.NoneTypesphinx.util.pycompat.TextIOWrapperio.TextIOWrappersphinx.util.pycompat.UnicodeMixinsphinx.util.pycompat.htmlescape()html.escape()sphinx.util.pycompat.indent()textwrap.indent()sphinx.util.pycompat.sys_encodingsys.getdefaultencoding()sphinx.util.pycompat.terminal_safe()sphinx.util.console.terminal_safe()sphinx.util.pycompat.usphinx.util.PeekableIteratorfilename argument in an overriddent
IndexBuilder.feed() method.IndexBuilder.feed(docname, filename, title, doctree)sphinx.writers.latex.ExtBabelsphinx.builders.latex.util.ExtBabelsphinx.writers.latex.LaTeXTranslator.babel_defmacro()sphinx.application.Sphinx._setting_up_extensionimporter argument of sphinx.ext.autodoc.importer._MockModulesphinx.ext.autodoc.importer._MockImportersphinx.io.SphinxBaseFileInputsphinx.io.SphinxFileInput.supportedsphinx.io.SphinxRSTFileInputsphinx.registry.SphinxComponentRegistry.add_source_input()sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()sphinx.writers.latex.LaTeXTranslator.collect_footnotes()sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()sphinx.writers.text.TextTranslator._make_depart_admonition()sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()!highlightlanghighlight!add_stylesheet~sphinx.application.Sphinx.add_css_file!add_javascript~sphinx.application.Sphinx.add_js_file!autodoc_default_flagsautodoc_default_optionscontent arguments of sphinx.util.image.guess_mimetype()gettext_compact arguments of
sphinx.util.i18n.find_catalog_source_files()sphinx.io.SphinxI18nReader.set_lineno_for_reporter()sphinx.io.SphinxI18nReader.linesphinx.directives.other.VersionChangesphinx.domains.changeset.VersionChangesphinx.highlighting.PygmentsBridge.unhighlight()trim_doctest_flags arguments of
sphinx.highlighting.PygmentsBridgesphinx.ext.mathbasesphinx.ext.mathbase.MathDomainsphinx.domains.math.MathDomainsphinx.ext.mathbase.MathDirectivesphinx.directives.patches.MathDirectivesphinx.ext.mathbase.math_role()docutils.parsers.rst.roles.math_role()sphinx.ext.mathbase.setup_math()~sphinx.application.Sphinx.add_html_math_renderersphinx.ext.mathbase.is_in_section_title()sphinx.ext.mathbase.get_node_equation_number()sphinx.util.math.get_node_equation_number()sphinx.ext.mathbase.wrap_displaymath()sphinx.util.math.wrap_displaymath()sphinx.ext.mathbase.math (node)docutils.nodes.mathsphinx.ext.mathbase.displaymath (node)docutils.nodes.math_blocksphinx.ext.mathbase.eqref (node)sphinx.builders.latex.nodes.math_reference!viewcode_import (config value)viewcode_follow_imported_memberssphinx.writers.latex.Table.caption_footnotetextssphinx.writers.latex.Table.header_footnotetextssphinx.writers.latex.LaTeXTranslator.footnotestacksphinx.writers.latex.LaTeXTranslator.in_container_literal_blocksphinx.writers.latex.LaTeXTranslator.next_section_idssphinx.writers.latex.LaTeXTranslator.next_hyperlink_idssphinx.writers.latex.LaTeXTranslator.restrict_footnote()sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()sphinx.writers.latex.LaTeXTranslator.bibitemssphinx.writers.latex.LaTeXTranslator.hlsettingstacksphinx.writers.latex.ExtBabel.get_shorthandoff()sphinx.writers.html.HTMLTranslator.highlightlang()sphinx.writers.html.HTMLTranslator.highlightlang_base()sphinx.writers.html.HTMLTranslator.highlightlangopts()sphinx.writers.html.HTMLTranslator.highlightlinenothreshold()sphinx.writers.html5.HTMLTranslator.highlightlang()sphinx.writers.html5.HTMLTranslator.highlightlang_base()sphinx.writers.html5.HTMLTranslator.highlightlangopts()sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold()sphinx.writers.latex.LaTeXTranslator.check_latex_elements()sphinx.application.CONFIG_FILENAMEsphinx.config.CONFIG_FILENAMEConfig.check_unicode()sphinx.config.check_unicode()Config.check_types()sphinx.config.check_confval_types()dirname, filename and tags arguments of
Config.__init__()Config.read()html_search_optionshtml_search_optionssphinx.versioning.prepare()sphinx.versioning.UIDTransformSphinx.override_domain()~sphinx.application.Sphinx.add_domainSphinx.import_object()sphinx.util.import_object()suffix argument of
:meth:~sphinx.application.Sphinx.add_source_parser~sphinx.application.Sphinx.add_source_suffixBuildEnvironment.load()pickle.load()BuildEnvironment.loads()pickle.loads()BuildEnvironment.frompickle()pickle.load()BuildEnvironment.dump()pickle.dump()BuildEnvironment.dumps()pickle.dumps()BuildEnvironment.topickle()pickle.dump()BuildEnvironment._nitpick_ignorenitpick_ignoreBuildEnvironment.versionchangesBuildEnvironment.update()Builder.read()BuildEnvironment.read_doc()Builder.read_doc()BuildEnvironment._read_serial()Builder.read()BuildEnvironment._read_parallel()Builder.read()BuildEnvironment.write_doctree()Builder.write_doctree()BuildEnvironment.note_versionchange()ChangesDomain.note_changeset()warn() (template helper function)warning()!source_parsers~sphinx.application.Sphinx.add_source_parsersphinx.util.docutils.directive_helper()Directive class of docutilssphinx.cmdlinesphinx.cmd.buildsphinx.make_modesphinx.cmd.make_modesphinx.locale.l_()sphinx.locale._sphinx.locale.lazy_gettext()sphinx.locale._sphinx.locale.mygettext()sphinx.locale._sphinx.util.copy_static_entry()sphinx.util.fileutil.copy_asset()sphinx.build_main()sphinx.cmd.build.build_main()sphinx.ext.intersphinx.debug()sphinx.ext.intersphinx.inspect_main()sphinx.ext.autodoc.format_annotation()sphinx.util.inspect.Signaturesphinx.ext.autodoc.formatargspec()sphinx.util.inspect.Signaturesphinx.ext.autodoc.AutodocReportersphinx.util.docutils.switch_source_input()sphinx.ext.autodoc.add_documenter()~sphinx.application.Sphinx.add_autodocumentersphinx.ext.autodoc.AutoDirective._register~sphinx.application.Sphinx.add_autodocumenterAutoDirective._special_attrgetters~sphinx.application.Sphinx.add_autodoc_attrgetterSphinx.warn(), Sphinx.info()logging-apiBuildEnvironment.set_warnfunc()logging-apiBuildEnvironment.note_toctree()Toctree.note() (in sphinx.environment.adapters.toctree)BuildEnvironment.get_toc_for()Toctree.get_toc_for() (in sphinx.environment.adapters.toctree)BuildEnvironment.get_toctree_for()Toctree.get_toctree_for() (in sphinx.environment.adapters.toctree)BuildEnvironment.create_index()IndexEntries.create_index() (in sphinx.environment.adapters.indexentries)sphinx.websupport
1.6
2.0
sphinxcontrib-websupport_
.. _sphinxcontrib-websupport: https://pypi.org/project/sphinxcontrib-websupport/
StandaloneHTMLBuilder.css_files!add_stylesheetdocument.settings.gettext_compactgettext_compactSphinx.status_iterator()sphinx.util.status_iterator()Sphinx.old_status_iterator()sphinx.util.old_status_iterator()Sphinx._directive_helper()sphinx.util.docutils.directive_helper()sphinx.util.compat.Directivedocutils.parsers.rst.Directivesphinx.util.compat.docutils_versionsphinx.util.docutils.__version_info__.. note:: On deprecating on public APIs (internal functions and classes), we also follow the policy as much as possible.