sdkagent

sphinx API reference

400 public APIs from sphinx (sphinx-doc/sphinx) — 173 classes, 91 functions, 136 methods. Signatures extracted by static analysis of the actual source.

Repository: sphinx-doc/sphinx

KindCount
Classes173
Functions91
Methods136

API list

funcsphinx._cli.util.colour.terminal_supports_colour() -> bool
Return True if coloured terminal output is supported.
funcsphinx._cli.util.errors.format_traceback(exception:BaseException, *short_traceback:bool=False) -> str
Format the given exception's traceback.
funcsphinx._cli.util.errors.strip_escape_sequences(text:str) -> str
Remove the ANSI CSI colors and "erase in line" sequences.
funcsphinx._cli.util.errors.terminal_safe(s:str) -> str
Safely encode a string for printing to the terminal.
funcsphinx._cli.util.errors.write_temporary_file(content:str) -> str
Write content to a temporary file and return the filename.
classsphinx.addnodes.acks
Special node for "acks" lists.
classsphinx.addnodes.centered
Deprecated.
classsphinx.addnodes.compact_paragraph
Node for a compact paragraph (which never makes a <p> node).
classsphinx.addnodes.desc_addname
Node for additional name parts for an object.
classsphinx.addnodes.desc_annotation
Node for signature annotations (not Python 3-style annotations).
classsphinx.addnodes.desc_content
Node for object description content.
classsphinx.addnodes.desc_inline
Node for a signature fragment in inline text.
classsphinx.addnodes.desc_name
Node for the main object name.
classsphinx.addnodes.desc_optional
Node for marking optional parts of the parameter list.
classsphinx.addnodes.desc_parameter
Node for a single parameter.
classsphinx.addnodes.desc_parameterlist
Node for a general parameter list.
classsphinx.addnodes.desc_returns
Node for a "returns" annotation (a la -> in Python).
classsphinx.addnodes.desc_sig_element
Common parent class of nodes for inline text of a signature.
classsphinx.addnodes.desc_sig_keyword
Node for a general keyword in a signature.
classsphinx.addnodes.desc_sig_keyword_type
Node for a keyword which is a built-in type in a signature.
classsphinx.addnodes.desc_sig_literal_char
Node for a character literal in a signature.
classsphinx.addnodes.desc_sig_literal_number
Node for a numeric literal in a signature.
classsphinx.addnodes.desc_sig_literal_string
Node for a string literal in a signature.
classsphinx.addnodes.desc_sig_name
Node for an identifier in a signature.
classsphinx.addnodes.desc_sig_operator
Node for an operator in a signature.
classsphinx.addnodes.desc_sig_punctuation
Node for punctuation in a signature.
classsphinx.addnodes.desc_sig_space
Node for a space in a signature.
classsphinx.addnodes.desc_signature
Node for a single object signature.
classsphinx.addnodes.desc_signature_line
Node for a line in a multi-line object signature.
classsphinx.addnodes.desc_type
Node for return types or object type names.
classsphinx.addnodes.desc_type_parameter
Node for a single type parameter.
classsphinx.addnodes.desc_type_parameter_list
Node for a general type parameter list.
classsphinx.addnodes.download_reference
Node for download references, similar to pending_xref.
classsphinx.addnodes.glossary
Node to insert a glossary.
classsphinx.addnodes.hlist
Node for "horizontal lists", i.e.
classsphinx.addnodes.hlistcol
Node for one column in a horizontal list.
classsphinx.addnodes.index
Node for index entries.
classsphinx.addnodes.manpage
Node for references to manpages.
classsphinx.addnodes.not_smartquotable
A node which does not support smart-quotes.
classsphinx.addnodes.number_reference
Node for number references, similar to pending_xref.
classsphinx.addnodes.only
Node for "only" directives (conditional inclusion based on tags).
classsphinx.addnodes.production
Node for a single grammar production rule.
classsphinx.addnodes.productionlist
Node for grammar production lists.
classsphinx.addnodes.seealso
Custom "see also" admonition.
classsphinx.addnodes.tabular_col_spec
Node for specifying tabular columns, used for LaTeX output.
classsphinx.addnodes.toctree
Node for inserting a "TOC tree".
classsphinx.addnodes.translatable
Node which supports translation.
methodsphinx.addnodes.translatable.apply_translated_message(original_message:str, translated_message:str) -> None
Apply translated message.
methodsphinx.addnodes.translatable.extract_original_messages() -> Sequence[str]
Extract translation messages.
methodsphinx.addnodes.translatable.preserve_original_messages() -> None
Preserve original translatable messages.
classsphinx.addnodes.versionmodified
Node for version change entries.
classsphinx.application.Sphinx
The main application class and extensibility interface.
methodsphinx.application.Sphinx.add_autodocumenter(cls:type[Documenter], override:bool=False) -> None
Register a new documenter class for the autodoc extension.
methodsphinx.application.Sphinx.add_builder(builder:type[Builder], override:bool=False) -> None
Register a new builder.
methodsphinx.application.Sphinx.add_config_value(name:str, default:Any, rebuild:_ConfigRebuild, types:type | Collection[type] | ENUM=(), description:str='') -> None
Register a configuration value.
methodsphinx.application.Sphinx.add_crossref_type(directivename:str, rolename:str, indextemplate:str='', ref_nodeclass:type[nodes.TextElement] | None=None, objname:str='', override:bool=False) -> None
Register a new crossref object type.
methodsphinx.application.Sphinx.add_css_file(filename:str, priority:int=500, **kwargs:Any) -> None
Register a stylesheet to include in the HTML output.
methodsphinx.application.Sphinx.add_directive(name:str, cls:type[Directive], override:bool=False) -> None
Register a Docutils directive.
methodsphinx.application.Sphinx.add_directive_to_domain(domain:str, name:str, cls:type[Directive], override:bool=False) -> None
Register a Docutils directive in a domain.
methodsphinx.application.Sphinx.add_domain(domain:type[Domain], override:bool=False) -> None
Register a domain.
methodsphinx.application.Sphinx.add_env_collector(collector:type[EnvironmentCollector]) -> None
Register an environment collector class.
methodsphinx.application.Sphinx.add_event(name:str) -> None
Register an event called *name*.
methodsphinx.application.Sphinx.add_generic_role(name:str, nodeclass:type[Node], override:bool=False) -> None
Register a generic Docutils role.
methodsphinx.application.Sphinx.add_html_math_renderer(name:str, inline_renderers:_MathsInlineRenderers | None=None, block_renderers:_MathsBlockRenderers | None=None) -> None
Register a math renderer for HTML.
methodsphinx.application.Sphinx.add_html_theme(name:str, theme_path:str | os.PathLike[str]) -> None
Register a HTML Theme.
methodsphinx.application.Sphinx.add_index_to_domain(domain:str, index:type[Index], _override:bool=False) -> None
Register a custom index for a domain.
methodsphinx.application.Sphinx.add_latex_package(packagename:str, options:str | None=None, after_hyperref:bool=False) -> None
Register a package to include in the LaTeX source code.
methodsphinx.application.Sphinx.add_lexer(alias:str, lexer:type[Lexer]) -> None
Register a new lexer for source code.
methodsphinx.application.Sphinx.add_message_catalog(catalog:str, locale_dir:str | os.PathLike[str]) -> None
Register a message catalog.
methodsphinx.application.Sphinx.add_node(node:type[Element], override:bool=False, **kwargs:_NodeHandlerPair) -> None
Register a Docutils node class.
methodsphinx.application.Sphinx.add_post_transform(transform:type[Transform]) -> None
Register a Docutils transform to be applied before writing.
methodsphinx.application.Sphinx.add_role(name:str, role:Any, override:bool=False) -> None
Register a Docutils role.
methodsphinx.application.Sphinx.add_role_to_domain(domain:str, name:str, role:RoleFunction | XRefRole, override:bool=False) -> None
Register a Docutils role in a domain.
methodsphinx.application.Sphinx.add_search_language(cls:type[SearchLanguage]) -> None
Register a new language for the HTML search index.
methodsphinx.application.Sphinx.add_source_parser(parser:type[Parser], override:bool=False) -> None
Register a parser class.
methodsphinx.application.Sphinx.add_source_suffix(suffix:str, filetype:str, override:bool=False) -> None
Register a suffix of source files.
methodsphinx.application.Sphinx.add_static_dir(path:str | os.PathLike[str]) -> None
Register a static directory to include in HTML output.
methodsphinx.application.Sphinx.add_transform(transform:type[Transform]) -> None
Register a Docutils transform to be applied after parsing.
methodsphinx.application.Sphinx.disconnect(listener_id:int) -> None
Unregister callback by *listener_id*.
methodsphinx.application.Sphinx.emit(event:str, *allowed_exceptions:tuple[type[Exception], ...]=(), *args:Any) -> list[Any]
Emit *event* and pass *arguments* to the callback functions.
methodsphinx.application.Sphinx.is_parallel_allowed(typ:str) -> bool
Check whether parallel processing is allowed or not.
methodsphinx.application.Sphinx.require_sphinx(version:tuple[int, int] | str) -> None
Check the Sphinx version if requested.
methodsphinx.application.Sphinx.set_html_assets_policy(policy:Literal['always', 'per_page']) -> None
Set the policy to include assets in HTML pages.
methodsphinx.application.Sphinx.set_translator(name:str, translator_class:type[nodes.NodeVisitor], override:bool=False) -> None
Register or override a Docutils translator class.
methodsphinx.application.Sphinx.setup_extension(extname:str) -> None
Import and setup a Sphinx extension module.
classsphinx.builders.Builder
Builds target formats from the reST sources.
methodsphinx.builders.Builder.build_all() -> None
Build all source files.
methodsphinx.builders.Builder.build_specific(filenames:Sequence[Path]) -> None
Only rebuild as much as needed for changes in the *filenames*.
methodsphinx.builders.Builder.build_update() -> None
Only rebuild what was changed or added since last build.
methodsphinx.builders.Builder.cleanup() -> None
Cleanup any resources.
methodsphinx.builders.Builder.create_template_bridge() -> None
Return the template bridge configured.
methodsphinx.builders.Builder.create_translator(*args:Any) -> nodes.NodeVisitor
Return an instance of translator.
methodsphinx.builders.Builder.finish() -> None
Finish the building process.
methodsphinx.builders.Builder.get_asset_paths() -> list[str]
Return list of paths for assets (ex.
methodsphinx.builders.Builder.get_builder_config(option:str, default:str) -> Any
Return a builder specific option.
methodsphinx.builders.Builder.get_relative_uri(from_:str, to:str, typ:str | None=None) -> str
Return a relative URI between two source filenames.
methodsphinx.builders.Builder.get_target_uri(docname:str, typ:str | None=None) -> str
Return the target URI for a document name.
methodsphinx.builders.Builder.get_translator_class(*args:Any) -> type[nodes.NodeVisitor]
Return a class of translator.
methodsphinx.builders.Builder.init() -> None
Load necessary templates and perform initialization.
methodsphinx.builders.Builder.post_process_images(doctree:Node) -> None
Pick the best candidate for all image URIs.
methodsphinx.builders.Builder.prepare_writing(docnames:Set[str]) -> None
A place where you can add logic before :meth:`write_doc` is run
methodsphinx.builders.Builder.read() -> list[str]
(Re-)read all files new or changed since last update.
methodsphinx.builders.Builder.read_doc(docname:str, *_cache:bool=True) -> None
Parse a file and add/update inventory entries for the doctree.
methodsphinx.builders.Builder.write(build_docnames:Iterable[str] | None, updated_docnames:Iterable[str], method:Literal['all', 'specific', 'update']='update') -> None
Write builder specific output files.
methodsphinx.builders.Builder.write_documents(docnames:Set[str]) -> None
Write all documents in *docnames*.
classsphinx.builders._epub_base.EpubBuilder
Builder that outputs epub files.
methodsphinx.builders._epub_base.EpubBuilder.add_visible_links(tree:nodes.document, show_urls:str='inline') -> None
Add visible link targets for external links
methodsphinx.builders._epub_base.EpubBuilder.build_container(outname:str='META-INF/container.xml') -> None
Write the metainfo file META-INF/container.xml.
methodsphinx.builders._epub_base.EpubBuilder.build_epub() -> None
Write the epub file.
methodsphinx.builders._epub_base.EpubBuilder.build_mimetype() -> None
Write the metainfo file mimetype.
methodsphinx.builders._epub_base.EpubBuilder.build_navpoints(nodes:list[dict[str, Any]]) -> list[NavPoint]
Create the toc navigation structure.
methodsphinx.builders._epub_base.EpubBuilder.build_toc() -> None
Write the metainfo file toc.ncx.
methodsphinx.builders._epub_base.EpubBuilder.copy_image_files() -> None
Copy image files to destination directory.
methodsphinx.builders._epub_base.EpubBuilder.copy_image_files_pil() -> None
Copy images using Pillow, the Python Imaging Library.
methodsphinx.builders._epub_base.EpubBuilder.fix_fragment(prefix:str, fragment:str) -> str
Return a href/id attribute with colons replaced by hyphens.
methodsphinx.builders._epub_base.EpubBuilder.fix_genindex(tree:list[tuple[str, list[tuple[str, Any]]]]) -> None
Fix href attributes for genindex pages.
methodsphinx.builders._epub_base.EpubBuilder.fix_ids(tree:nodes.document) -> None
Replace colons with hyphens in href and id attributes.
methodsphinx.builders._epub_base.EpubBuilder.handle_page(pagename:str, addctx:dict[str, Any], templatename:str='page.html', *outfilename:Path | None=None, *event_arg:Any=None) -> None
Create a rendered page.
methodsphinx.builders._epub_base.EpubBuilder.is_vector_graphics(filename:str) -> bool
Does the filename extension indicate a vector graphic format?
methodsphinx.builders._epub_base.EpubBuilder.make_id(name:str) -> str
Return a unique id for name.
methodsphinx.builders._epub_base.EpubBuilder.new_navpoint(node:dict[str, Any], level:int, incr:bool=True) -> NavPoint
Create a new entry in the toc from the node at given level.
methodsphinx.builders._epub_base.EpubBuilder.toc_add_files(refnodes:list[dict[str, Any]]) -> None
Add the root_doc, pre and post files to a list of refnodes.
methodsphinx.builders._epub_base.EpubBuilder.write_doc(docname:str, doctree:nodes.document) -> None
Write one document file.
classsphinx.builders.changes.ChangesBuilder
Write a summary with all version-related directives.
classsphinx.builders.epub3.Epub3Builder
Builder that outputs epub3 files.
methodsphinx.builders.epub3.Epub3Builder.build_navigation_doc() -> None
Write the metainfo file nav.xhtml.
methodsphinx.builders.epub3.Epub3Builder.build_navlist(navnodes:list[dict[str, Any]]) -> list[NavPoint]
Create the toc navigation structure.
methodsphinx.builders.epub3.Epub3Builder.handle_finish() -> None
Create the metainfo files and finally the epub.
funcsphinx.builders.epub3.convert_epub_css_files(app:Sphinx, config:Config) -> None
Convert string styled epub_css_files to tuple styled one.
classsphinx.builders.gettext.Catalog
Catalog of translatable messages.
classsphinx.builders.gettext.I18nBuilder
General i18n builder.
classsphinx.builders.gettext.I18nTags
Dummy tags module for I18nBuilder.
classsphinx.builders.gettext.Message
An entry of translatable message.
classsphinx.builders.gettext.MessageCatalogBuilder
Builds gettext-style message catalogs (.pot files).
classsphinx.builders.gettext.MsgOrigin
Origin holder for Catalog message origin.
classsphinx.builders.html.StandaloneHTMLBuilder
Builds standalone HTML docs.
methodsphinx.builders.html.StandaloneHTMLBuilder.copy_extra_files() -> None
Copy html_extra_path files.
methodsphinx.builders.html.StandaloneHTMLBuilder.copy_static_dirs() -> None
Copy static files registered by extensions.
methodsphinx.builders.html.StandaloneHTMLBuilder.copy_stemmer_js() -> None
Copy a JavaScript file for stemmer.
methodsphinx.builders.html.StandaloneHTMLBuilder.copy_translation_js() -> None
Copy a JavaScript file for translations.
methodsphinx.builders.html.StandaloneHTMLBuilder.create_pygments_style_file() -> None
Create a style file for pygments.
methodsphinx.builders.html.StandaloneHTMLBuilder.get_doc_context(docname:str, body:str, metatags:str) -> dict[str, Any]
Collect items for the template context of a page.
methodsphinx.builders.html.StandaloneHTMLBuilder.render_partial(node:Node | None) -> dict[str, str]
Utility: Render a lone doctree node.
classsphinx.builders.html._build_info.BuildInfo
buildinfo file manipulator.
funcsphinx.builders.html.convert_html_css_files(app:Sphinx, config:Config) -> None
Convert string styled html_css_files to tuple styled one.
funcsphinx.builders.html.convert_html_js_files(app:Sphinx, config:Config) -> None
Convert string styled html_js_files to tuple styled one.
funcsphinx.builders.html.convert_locale_to_language_tag(locale:str | None) -> str | None
Convert a locale string to a language tag (ex.
funcsphinx.builders.html.error_on_html_4(_app:Sphinx, config:Config) -> None
Error on HTML 4.
funcsphinx.builders.html.error_on_html_sidebars_string_values(app:Sphinx, config:Config) -> None
Support removed in Sphinx 2.
funcsphinx.builders.html.setup_resource_paths(app:Sphinx, pagename:str, templatename:str, context:dict[str, Any], doctree:Node) -> None
Set up relative resource paths.
funcsphinx.builders.html.validate_html_extra_path(app:Sphinx, config:Config) -> None
Check html_extra_paths setting.
funcsphinx.builders.html.validate_html_favicon(app:Sphinx, config:Config) -> None
Check html_favicon setting.
funcsphinx.builders.html.validate_html_logo(app:Sphinx, config:Config) -> None
Check html_logo setting.
funcsphinx.builders.html.validate_html_static_path(app:Sphinx, config:Config) -> None
Check html_static_paths setting.
classsphinx.builders.latex.LaTeXBuilder
Builds LaTeX output to create PDF.
methodsphinx.builders.latex.LaTeXBuilder.copy_support_files() -> None
Copy TeX support files from texinputs.
funcsphinx.builders.latex.default_latex_docclass(config:Config) -> dict[str, str]
Better default latex_docclass settings for specific languages.
funcsphinx.builders.latex.default_latex_documents(config:Config) -> list[tuple[str, str, str, str, str]]
Better default latex_documents settings.
funcsphinx.builders.latex.default_latex_engine(config:Config) -> str
Better default latex_engine settings for specific languages.
funcsphinx.builders.latex.default_latex_use_xindy(config:Config) -> bool
Better default latex_use_xindy settings for specific engines.
funcsphinx.builders.latex.install_packages_for_ja(app:Sphinx) -> None
Install packages for Japanese.
classsphinx.builders.latex.nodes.footnotemark
A node represents ``\footnotemark``.
classsphinx.builders.latex.nodes.footnotetext
A node represents ``\footnotetext``.
classsphinx.builders.latex.nodes.math_reference
A node for a reference for equation.
classsphinx.builders.latex.nodes.thebibliography
A node for wrapping bibliographies.
classsphinx.builders.latex.theming.BuiltInTheme
A built-in LaTeX theme.
classsphinx.builders.latex.theming.Theme
A set of LaTeX configurations.
methodsphinx.builders.latex.theming.Theme.update(config:Config) -> None
Override theme settings by user's configuration.
classsphinx.builders.latex.theming.ThemeFactory
A factory class for LaTeX Themes.
methodsphinx.builders.latex.theming.ThemeFactory.find_user_theme(name:str) -> Theme | None
Find a theme named as *name* from latex_theme_path.
methodsphinx.builders.latex.theming.ThemeFactory.get(name:str) -> Theme
Get a theme for given *name*.
methodsphinx.builders.latex.theming.ThemeFactory.load_builtin_themes(config:Config) -> None
Load built-in themes.
classsphinx.builders.latex.theming.UserTheme
A user defined LaTeX theme.
classsphinx.builders.latex.transforms.BibliographyTransform
Gather bibliography entries to tail of document.
classsphinx.builders.latex.transforms.FootnoteDocnameUpdater
Add docname to footnote and footnote_reference nodes.
classsphinx.builders.latex.transforms.ShowUrlsTransform
Expand references to inline text or footnotes.
classsphinx.builders.linkcheck.AnchorCheckParser
Specialised HTML parser that looks for a specific anchor.
classsphinx.builders.linkcheck.CheckExternalLinksBuilder
Checks for broken external links.
funcsphinx.builders.linkcheck.compile_linkcheck_allowed_redirects(app:Sphinx, config:Config) -> None
Compile patterns to the regexp objects.
funcsphinx.builders.linkcheck.contains_anchor(response:Response, anchor:str) -> bool
Determine if an anchor is contained within an HTTP response.
classsphinx.builders.manpage.ManualPageBuilder
Builds groff output in manual page format.
funcsphinx.builders.manpage.default_man_pages(config:Config) -> list[tuple[str, str, str, list[str], int]]
Better default man_pages settings.
classsphinx.builders.singlehtml.SingleFileHTMLBuilder
Builds the whole document tree as a single HTML page.
classsphinx.builders.texinfo.TexinfoBuilder
Builds Texinfo output to create Info documentation.
funcsphinx.builders.texinfo.default_texinfo_documents(config:Config) -> list[tuple[str, str, str, str, str, str, str]]
Better default texinfo_documents settings.
classsphinx.builders.xml.PseudoXMLBuilder
Builds pseudo-XML for display purposes.
classsphinx.builders.xml.XMLBuilder
Builds Docutils-native XML.
funcsphinx.cmd.build.build_main(argv:Sequence[str]) -> int
Sphinx build "main" command-line entry.
funcsphinx.cmd.build.jobs_argument(value:str) -> int
Parse the ``--jobs`` flag.
funcsphinx.cmd.build.make_main(argv:Sequence[str]) -> int
Sphinx build "make mode" entry.
classsphinx.cmd.quickstart.ValidationError
Raised for validation errors.
funcsphinx.cmd.quickstart.ask_user(d:dict[str, Any]) -> None
Ask the user for quickstart values missing from *d*.
funcsphinx.cmd.quickstart.generate(d:dict[str, Any], overwrite:bool=True, silent:bool=False, templatedir:str | None=None) -> None
Generate project based on values in *d*.
classsphinx.config.Config
Configuration file abstraction.
methodsphinx.config.Config.read(confdir:str | os.PathLike[str], *overrides:dict[str, Any], *tags:Tags) -> Config
Create a Config object from configuration file.
classsphinx.config.ENUM
Represents the candidates which a config value should be one of.
funcsphinx.config.convert_highlight_options(app:Sphinx, config:Config) -> None
Convert old styled highlight_options to new styled one.
funcsphinx.config.convert_source_suffix(app:Sphinx, config:Config) -> None
Convert old styled source_suffix to new styled one.
funcsphinx.config.deprecate_source_encoding(_app:Sphinx, config:Config) -> None
Warn on non-UTF 8 source_encoding.
funcsphinx.config.eval_config_file(filename:Path, tags:Tags) -> dict[str, Any]
Evaluate a config file.
funcsphinx.config.evaluate_copyright_placeholders(_app:Sphinx, config:Config) -> None
Replace copyright year placeholders (%Y) with the current year.
funcsphinx.config.init_numfig_format(app:Sphinx, config:Config) -> None
Initialize :confval:`numfig_format`.
funcsphinx.config.is_serializable(obj:object, *_seen:frozenset[int]=frozenset()) -> bool
Check if an object is serializable or not.
classsphinx.directives.DefaultRole
Set the default interpreted text role.
classsphinx.directives.ObjectDescription
Directive to describe a class, function or similar object.
methodsphinx.directives.ObjectDescription.after_content() -> None
Called after parsing content.
methodsphinx.directives.ObjectDescription.before_content() -> None
Called before parsing content.
methodsphinx.directives.ObjectDescription.handle_signature(sig:str, signode:desc_signature) -> ObjDescT
Parse the signature *sig*.
methodsphinx.directives.ObjectDescription.transform_content(content_node:addnodes.desc_content) -> None
Can be used to manipulate the content.
classsphinx.directives.admonitions.SeeAlso
An admonition mentioning things to look at as reference.
classsphinx.directives.code.LiteralInclude
Like ``..
classsphinx.directives.other.Acks
Directive for a list of names.
classsphinx.directives.other.Centered
Directive to create a centered line of bold text.
classsphinx.directives.other.HList
Directive for a list that gets compacted horizontally.
classsphinx.directives.patches.Code
Parse and mark up content of a code block.
methodsphinx.domains.Domain.add_object_type(name:str, objtype:ObjType) -> None
Add an object type.
methodsphinx.domains.Domain.check_consistency() -> None
Do consistency checks (**experimental**).
methodsphinx.domains.Domain.clear_doc(docname:str) -> None
Remove traces of a document in the domain-specific inventories.
methodsphinx.domains.Domain.get_enumerable_node_type(node:Node) -> str | None
Get type of enumerable nodes (experimental).
methodsphinx.domains.Domain.get_full_qualified_name(node:Element) -> str | None
Return full qualified name for given node.
methodsphinx.domains.Domain.get_objects() -> Iterable[tuple[str, str, str, str, str, int]]
Return an iterable of "object descriptions".
methodsphinx.domains.Domain.get_type_name(type:ObjType, primary:bool=False) -> str
Return full name for given ObjType.
methodsphinx.domains.Domain.process_doc(env:BuildEnvironment, docname:str, document:nodes.document) -> None
Process a document after it is read by the environment.
methodsphinx.domains.Domain.process_field_xref(pnode:pending_xref) -> None
Process a pending xref created in a doc field.
classsphinx.domains._index.Index
An Index is the description for a domain-specific index.
methodsphinx.domains._index.Index.generate(docnames:Iterable[str] | None=None) -> tuple[list[tuple[str, list[IndexEntry]]], bool]
Get entries for the index.
classsphinx.domains._index.IndexEntry
An index entry.
classsphinx.domains.c.CDomain
C language domain.
classsphinx.domains.c.CObject
Description of a C language object.
classsphinx.domains.changeset.ChangeSetDomain
Domain for changesets.
classsphinx.domains.citation.CitationDefinitionTransform
Mark citation definition labels as not smartquoted.
classsphinx.domains.citation.CitationDomain
Domain for citations.
classsphinx.domains.cpp.CPPDomain
C++ language domain.
classsphinx.domains.cpp.CPPObject
Description of a C++ language object.
classsphinx.domains.index.IndexDirective
Directive to add entries to the index.
classsphinx.domains.index.IndexDomain
Index domain.
methodsphinx.domains.index.IndexDomain.process_doc(env:BuildEnvironment, docname:str, document:Node) -> None
Process a document after it is read by the environment.
classsphinx.domains.javascript.JSCallable
Description of a JavaScript function, method or constructor.
classsphinx.domains.javascript.JSConstructor
Like a callable but with a different prefix.
classsphinx.domains.javascript.JSModule
Directive to mark description of a new JavaScript module.
classsphinx.domains.javascript.JSObject
Description of a JavaScript object.
classsphinx.domains.javascript.JavaScriptDomain
JavaScript language domain.
classsphinx.domains.math.MathDomain
Mathematics domain.
classsphinx.domains.python.PyAttribute
Description of an attribute.
classsphinx.domains.python.PyClassMethod
Description of a classmethod.
classsphinx.domains.python.PyDecoratorFunction
Description of a decorator.
classsphinx.domains.python.PyDecoratorMethod
Description of a decoratormethod.
classsphinx.domains.python.PyFunction
Description of a function.
classsphinx.domains.python.PyMethod
Description of a method.
classsphinx.domains.python.PyModule
Directive to mark description of a new module.
classsphinx.domains.python.PyProperty
Description of an attribute.
classsphinx.domains.python.PyStaticMethod
Description of a staticmethod.
classsphinx.domains.python.PyTypeAlias
Description of a type alias.
classsphinx.domains.python.PyVariable
Description of a variable.
classsphinx.domains.python.PythonDomain
Python language domain.
methodsphinx.domains.python.PythonDomain.note_module(name:str, node_id:str, synopsis:str, platform:str, deprecated:bool) -> None
Note a python module for cross reference.
methodsphinx.domains.python.PythonDomain.note_object(name:str, objtype:str, node_id:str, aliased:bool=False, location:Any=None) -> None
Note a python object for cross reference.
classsphinx.domains.python.PythonModuleIndex
Index subclass to provide the Python module index.
funcsphinx.domains.python._annotations.type_to_xref(target:str, env:BuildEnvironment, *suppress_prefix:bool=False) -> addnodes.pending_xref
Convert a type string to a cross reference node.
classsphinx.domains.python._object.PyObject
Description of a general Python object.
methodsphinx.domains.python._object.PyObject.get_index_text(modname:str, name:tuple[str, str]) -> str
Return the text for the index entry of the object.
methodsphinx.domains.python._object.PyObject.handle_signature(sig:str, signode:desc_signature) -> tuple[str, str]
Transform a Python signature into RST nodes.
funcsphinx.domains.python.builtin_resolver(app:Sphinx, env:BuildEnvironment, node:pending_xref, contnode:Element) -> Element | None
Do not emit nitpicky warnings for built-in types.
funcsphinx.domains.python.filter_meta_fields(app:Sphinx, domain:str, objtype:str, content:Element) -> None
Filter ``:meta:`` field from its docstring.
classsphinx.domains.rst.ReSTDirective
Description of a reST directive.
classsphinx.domains.rst.ReSTDirectiveOption
Description of an option for reST directive.
classsphinx.domains.rst.ReSTDomain
ReStructuredText domain.
classsphinx.domains.rst.ReSTMarkup
Description of generic reST markup.
classsphinx.domains.rst.ReSTRole
Description of a reST role.
funcsphinx.domains.rst.parse_directive(d:str) -> tuple[str, str]
Parse a directive signature.
classsphinx.domains.std.Cmdoption
Description of a command-line option (..
methodsphinx.domains.std.Cmdoption.handle_signature(sig:str, signode:desc_signature) -> str
Transform an option description into RST nodes.
classsphinx.domains.std.ProductionList
Directive to list grammar productions.
methodsphinx.domains.std.ProductionList.make_name_target(*name:str, *production_group:str, *location:str) -> addnodes.literal_strong
Make a link target for the given production.
methodsphinx.domains.std.ProductionList.separator_node(*name:str, *max_len:int) -> nodes.Text
Return separator between 'name' and 'tokens'.
classsphinx.domains.std.Program
Directive to name the program for which options are documented.
classsphinx.domains.std.Target
Generic target for user-defined cross-reference types.
classsphinx.environment.BuildEnvironment
The environment in which the ReST files are translated.
methodsphinx.environment.BuildEnvironment.apply_post_transforms(doctree:nodes.document, docname:str) -> None
Apply all post-transforms.
methodsphinx.environment.BuildEnvironment.check_consistency() -> None
Do consistency checks.
methodsphinx.environment.BuildEnvironment.clear_doc(docname:str) -> None
Remove all traces of a source file in the inventory.
methodsphinx.environment.BuildEnvironment.doc2path(docname:str, base:bool=True) -> _StrPath
Return the filename for the document name.
methodsphinx.environment.BuildEnvironment.found_docs() -> set[str]
Contains all existing docnames.
methodsphinx.environment.BuildEnvironment.get_doctree(docname:str) -> nodes.document
Read the doctree for a file from the pickle and return it.
methodsphinx.environment.BuildEnvironment.get_domain(domainname:str) -> Domain
Return the domain instance with the specified name.
methodsphinx.environment.BuildEnvironment.get_outdated_files(config_changed:bool) -> tuple[set[str], set[str], set[str]]
Return (added, changed, removed) sets.
methodsphinx.environment.BuildEnvironment.new_serialno(category:str='') -> int
Return a serial number, e.g.
methodsphinx.environment.BuildEnvironment.note_dependency(filename:str | os.PathLike[str], *docname:str | None=None) -> None
Add *filename* as a dependency of the current document.
methodsphinx.environment.BuildEnvironment.note_included(filename:str | os.PathLike[str]) -> None
Add *filename* as a included from other document.
methodsphinx.environment.BuildEnvironment.path2doc(filename:str | os.PathLike[str]) -> str | None
Return the docname for the filename if the file is document.
methodsphinx.environment.BuildEnvironment.prepare_settings(docname:str) -> None
Prepare to set up environment for reading.
funcsphinx.environment.adapters.toctree.document_toc(env:BuildEnvironment, docname:str, tags:Tags) -> Node
Get the (local) table of contents for a document.
classsphinx.environment.collectors.asset.DownloadFileCollector
Download files collector for sphinx.environment.
methodsphinx.environment.collectors.asset.DownloadFileCollector.process_doc(app:Sphinx, doctree:nodes.document) -> None
Process downloadable file paths.
classsphinx.environment.collectors.asset.ImageCollector
Image files collector for sphinx.environment.
methodsphinx.environment.collectors.asset.ImageCollector.process_doc(app:Sphinx, doctree:nodes.document) -> None
Process and rewrite image URIs.
classsphinx.environment.collectors.dependencies.DependenciesCollector
dependencies collector for sphinx.environment.
methodsphinx.environment.collectors.dependencies.DependenciesCollector.process_doc(app:Sphinx, doctree:nodes.document) -> None
Process docutils-generated dependency info.
classsphinx.environment.collectors.metadata.MetadataCollector
metadata collector for sphinx.environment.
methodsphinx.environment.collectors.metadata.MetadataCollector.process_doc(app:Sphinx, doctree:nodes.document) -> None
Process the docinfo part of the doctree as metadata.
classsphinx.environment.collectors.title.TitleCollector
title collector for sphinx.environment.
classsphinx.errors.ApplicationError
Application initialization error.
classsphinx.errors.BuildEnvironmentError
BuildEnvironment error.
classsphinx.errors.ConfigError
Configuration error.
classsphinx.errors.DocumentError
Document error.
classsphinx.errors.ExtensionError
Extension error.
classsphinx.errors.PycodeError
Pycode Python source code analyser error.
classsphinx.errors.SphinxError
Base class for Sphinx errors.
classsphinx.errors.SphinxParallelError
Sphinx parallel build error.
classsphinx.errors.SphinxWarning
Warning, treated as error.
classsphinx.errors.ThemeError
Theme error.
classsphinx.errors.VersionRequirementError
Incompatible Sphinx version error.
classsphinx.events.EventManager
Event manager for Sphinx.
methodsphinx.events.EventManager.add(name:str) -> None
Register a custom Sphinx event called *name*.
methodsphinx.events.EventManager.disconnect(listener_id:int) -> None
Disconnect the handler given by *listener_id*.
methodsphinx.events.EventManager.emit(name:str, *allowed_exceptions:tuple[type[Exception], ...]=(), *args:Any) -> list[Any]
Emit a Sphinx event.
methodsphinx.events.EventManager.emit_firstresult(name:str, *allowed_exceptions:tuple[type[Exception], ...]=(), *args:Any) -> Any
Emit a Sphinx event and return the first result.
funcsphinx.ext.apidoc._cli.main(argv:Sequence[str]=()) -> int
Run the apidoc CLI.
funcsphinx.ext.apidoc._extension.run_apidoc(app:Sphinx) -> None
Run the apidoc extension.
funcsphinx.ext.apidoc._generate.create_modules_toc_file(modules:list[str], opts:ApidocOptions, name:str='modules', user_template_dir:str | os.PathLike[str] | None=None) -> Path
Create the module's index.
funcsphinx.ext.apidoc._generate.is_excluded(root:str | Path, excludes:Sequence[re.Pattern[str]]) -> bool
Check if the directory is in the exclude list.
funcsphinx.ext.apidoc._generate.is_initpy(filename:str | Path) -> bool
Check *filename* is __init__ file or not.
funcsphinx.ext.apidoc._generate.is_package_dir(files:Iterable[Path | str]=(), *dir_path:Path | None=None) -> bool
Check given *files* contains __init__ file.
funcsphinx.ext.apidoc._generate.is_skipped_module(filename:str | Path, opts:ApidocOptions, _excludes:Sequence[re.Pattern[str]]) -> bool
Check if we want to skip this module.
funcsphinx.ext.apidoc._generate.is_skipped_package(dirname:str | Path, opts:ApidocOptions, excludes:Sequence[re.Pattern[str]]=()) -> bool
Check if we want to skip this module.
funcsphinx.ext.apidoc._generate.module_join(*modnames:str | None) -> str
Join module names with dots.
funcsphinx.ext.apidoc._generate.write_file(name:str, text:str, opts:ApidocOptions) -> Path
Write the output file for module/package <name>.
classsphinx.ext.apidoc._shared.ApidocDefaults
Default values for apidoc options.
methodsphinx.ext.apidoc._shared.ApidocDefaults.from_config(config:Config) -> Self
Collect the default values for apidoc options.
classsphinx.ext.apidoc._shared.ApidocOptions
Options for apidoc.
classsphinx.ext.autodoc._directive.AutodocDirective
A directive class for all autodoc directives.
classsphinx.ext.autodoc._directive.DummyOptionSpec
An option_spec allows any options.
funcsphinx.ext.autodoc._directive_options.bool_option(arg:str | None) -> bool
Used to convert flag options to auto directives.
funcsphinx.ext.autodoc._directive_options.exclude_members_option(arg:str | None) -> EMPTY_T | set[str]
Used to convert the :exclude-members: option.
funcsphinx.ext.autodoc._directive_options.members_option(arg:str | None) -> ALL_T | list[str] | None
Used to convert the :members: option to auto directives.
classsphinx.ext.autodoc._dynamic._member_finder.ObjectMember
A member of object.
funcsphinx.ext.autodoc._dynamic._member_finder.unmangle(subject:Any, name:str) -> str | None
Unmangle the given name.
classsphinx.ext.autodoc._dynamic._mock.MockFinder
A finder for mocking.
methodsphinx.ext.autodoc._dynamic._mock.MockFinder.invalidate_caches() -> None
Invalidate mocked modules on sys.modules.
classsphinx.ext.autodoc._dynamic._mock.MockLoader
A loader for mocking.
funcsphinx.ext.autodoc._dynamic._mock.ismock(subject:Any) -> bool
Check if the object is mocked.
funcsphinx.ext.autodoc._dynamic._mock.ismockmodule(subject:Any) -> TypeIs[_MockModule]
Check if the object is a mocked module.
funcsphinx.ext.autodoc._dynamic._mock.undecorate(subject:_MockObject) -> Any
Unwrap mock if *subject* is decorated by mocked object.
funcsphinx.ext.autodoc._dynamic._preserve_defaults.update_default_value(obj:Any, bound_method:bool) -> None
Update default value info of *obj* using type_comments.
funcsphinx.ext.autodoc._dynamic._type_comments.not_suppressed(argtypes:Sequence[ast.expr]=()) -> bool
Check given *argtypes* is suppressed type_comment or not.
funcsphinx.ext.autodoc._legacy_class_based._directive_options.bool_option(arg:Any) -> bool
Used to convert flag options to auto directives.
funcsphinx.ext.autodoc._legacy_class_based._directive_options.exclude_members_option(arg:Any) -> object | set[str]
Used to convert the :exclude-members: option.
classsphinx.ext.autodoc._legacy_class_based._documenters.AttributeDocumenter
Specialized Documenter subclass for attributes.
classsphinx.ext.autodoc._legacy_class_based._documenters.ClassDocumenter
Specialized Documenter subclass for classes.
classsphinx.ext.autodoc._legacy_class_based._documenters.DataDocumenter
Specialized Documenter subclass for data items.
classsphinx.ext.autodoc._legacy_class_based._documenters.FunctionDocumenter
Specialized Documenter subclass for functions.
classsphinx.ext.autodoc._legacy_class_based._documenters.ModuleDocumenter
Specialized Documenter subclass for modules.
methodsphinx.ext.autodoc._legacy_class_based._documenters.ModuleDocumenter.get_module_members() -> dict[str, ObjectMember]
Get members of target module.
classsphinx.ext.autodoc._legacy_class_based._documenters.ObjectMember
A member of object.
classsphinx.ext.autodoc._legacy_class_based._documenters.PropertyDocumenter
Specialized Documenter subclass for properties.
funcsphinx.ext.autodoc._legacy_class_based._documenters.autodoc_attrgetter(obj:Any, name:str, *registry:SphinxComponentRegistry, *defargs:Any) -> Any
Alternative getattr() for types
classsphinx.ext.autodoc.directive.AutodocDirective
A directive class for all autodoc directives.
classsphinx.ext.autodoc.directive.DocumenterBridge
A parameters container for Documenters.
classsphinx.ext.autodoc.directive.DummyOptionSpec
An option_spec allows any options.
funcsphinx.ext.autodoc.directive.parse_generated_content(state:RSTState, content:StringList, documenter:Documenter) -> list[Node]
Parse an item of content generated by Documenter.
funcsphinx.ext.autodoc.directive.process_documenter_options(documenter:type[Documenter], config:Config, options:dict[str, str]) -> Options
Recognize options of Documenter from user input.
funcsphinx.ext.autodoc.importer.get_class_members(subject:Any, objpath:Any, attrgetter:_AttrGetter, inherit_docstrings:bool=True) -> dict[str, ObjectMember]
Get members and attributes of target class.
funcsphinx.ext.autodoc.preserve_defaults.update_defvalue(app:Sphinx, obj:Any, bound_method:bool) -> None
Update defvalue info of *obj* using type_comments.
funcsphinx.ext.autodoc.typehints.record_typehints(app:Sphinx, objtype:str, name:str, obj:Any, options:Options, args:str, retann:str) -> None
Record type hints to env object.
classsphinx.ext.autosummary.AutoLink
Smart linking role.
classsphinx.ext.autosummary.ImportExceptionGroup
Exceptions raised during importing the target objects.
funcsphinx.ext.autosummary.autosummary_table_visit_html(self:HTML5Translator, node:autosummary_table) -> None
Make the first column of the table non-breaking.
funcsphinx.ext.autosummary.autosummary_toc_visit_html(self:nodes.NodeVisitor, node:autosummary_toc) -> None
Hide autosummary toctree list in HTML output.
funcsphinx.ext.autosummary.extract_summary(doc:Sequence[str], settings:Any) -> str
Extract summary from docstring.
classsphinx.ext.autosummary.generate.AutosummaryRenderer
A helper class for rendering.
methodsphinx.ext.autosummary.generate.AutosummaryRenderer.render(template_name:str, context:dict[str, Any]) -> str
Render a template file.
classsphinx.ext.autosummary.generate.DummyApplication
Dummy Application class for sphinx-autogen command.
funcsphinx.ext.autosummary.mangle_signature(sig:str, max_chars:int=30) -> str
Reformat a function signature to a more compact form.
funcsphinx.ext.autosummary.strip_arg_typehint(s:str) -> str
Strip a type hint from argument definition.
classsphinx.ext.coverage.CoverageBuilder
Evaluates coverage of code in the documentation.
classsphinx.ext.doctest.DocTestBuilder
Runs test snippets in the documentation.
methodsphinx.ext.doctest.DocTestBuilder.get_line_number(node:Node) -> int | None
Get the real line number or admit we don't know.
classsphinx.ext.doctest.TestDirective
Base class for doctest-related directives.
funcsphinx.ext.doctest.is_allowed_version(spec:str, version:str) -> bool
Check `spec` satisfies `version` or not.
classsphinx.ext.duration.DurationDomain
A domain for durations of Sphinx processing.
funcsphinx.ext.duration.on_build_finished(app:Sphinx, error:Exception) -> None
Display duration ranking on the current build.
funcsphinx.ext.duration.on_builder_inited(app:Sphinx) -> None
Initialize DurationDomain on bootstrap.
funcsphinx.ext.duration.on_doctree_read(app:Sphinx, doctree:nodes.document) -> None
Record a reading duration.
funcsphinx.ext.duration.on_source_read(app:Sphinx, docname:str, content:list[str]) -> None
Start to measure reading duration.
classsphinx.ext.graphviz.ClickableMapDefinition
A manipulator for clickable map file of graphviz.
classsphinx.ext.graphviz.Graphviz
Directive to insert arbitrary dot markup.
classsphinx.ext.graphviz.GraphvizSimple
Directive to insert arbitrary dot markup.
classsphinx.ext.imgmath.InvokeError
errors on invoking converters.
funcsphinx.ext.imgmath.compile_math(latex:str, *config:Config) -> Path
Compile LaTeX macros for math to DVI.
funcsphinx.ext.imgmath.convert_dvi_to_image(command:list[str], name:str) -> tuple[str, str]
Convert DVI file to specific image format.
funcsphinx.ext.imgmath.convert_dvi_to_png(dvipath:Path, out_path:Path, *config:Config) -> int | None
Convert DVI file to PNG image.
funcsphinx.ext.imgmath.convert_dvi_to_svg(dvipath:Path, out_path:Path, *config:Config) -> int | None
Convert DVI file to SVG image.
funcsphinx.ext.imgmath.generate_latex_macro(image_format:str, math:str, config:Config, confdir:_StrPath) -> str
Generate LaTeX macro.
funcsphinx.ext.imgmath.read_svg_depth(filename:str | os.PathLike[str]) -> int | None
Read the depth from comment at last line of SVG file
funcsphinx.ext.imgmath.write_svg_depth(filename:Path, depth:int) -> None
Write the depth to SVG file as a comment at end of file
funcsphinx.ext.inheritance_diagram.html_visit_inheritance_diagram(self:HTML5Translator, node:inheritance_diagram) -> None
Output the graph for HTML.
funcsphinx.ext.inheritance_diagram.import_classes(name:str, currmodule:str) -> list[type[Any]]
Import a class using its fully-qualified *name*.
funcsphinx.ext.inheritance_diagram.latex_visit_inheritance_diagram(self:LaTeXTranslator, node:inheritance_diagram) -> None
Output the graph for LaTeX.
funcsphinx.ext.inheritance_diagram.texinfo_visit_inheritance_diagram(self:TexinfoTranslator, node:inheritance_diagram) -> None
Output the graph for Texinfo.
funcsphinx.ext.inheritance_diagram.try_import(objname:str) -> Any
Import a object or module using *name* and *currentmodule*.

About this data

These signatures were extracted from the public source of sphinx-doc/sphinx using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries