Index

Symbols

--author sphinx-quickstart command line option --batchfile sphinx-quickstart command line option --builder sphinx-build command line option --color sphinx-build command line option --conf-dir sphinx-build command line option --define sphinx-build command line option --doctree-dir sphinx-build command line option --dot sphinx-quickstart command line option --dry-run sphinx-apidoc command line option --exception-on-warning sphinx-build command line option --ext-autodoc sphinx-quickstart command line option --ext-coverage sphinx-quickstart command line option --ext-doctest sphinx-quickstart command line option --ext-githubpages sphinx-quickstart command line option --ext-ifconfig sphinx-quickstart command line option --ext-imgmath sphinx-quickstart command line option --ext-intersphinx sphinx-quickstart command line option --ext-mathjax sphinx-quickstart command line option --ext-todo sphinx-quickstart command line option --ext-viewcode sphinx-quickstart command line option --extensions sphinx-quickstart command line option --fail-on-warning sphinx-build command line option --follow-links sphinx-apidoc command line option --force sphinx-apidoc command line option --fresh-env sphinx-build command line option --full sphinx-apidoc command line option --help sphinx-build command line option sphinx-quickstart command line option --html-define sphinx-build command line option --implicit-namespaces sphinx-apidoc command line option --imported-members sphinx-autogen command line option --isolated sphinx-build command line option --jobs sphinx-build command line option --keep-going sphinx-build command line option --language sphinx-quickstart command line option --makefile sphinx-quickstart command line option --master sphinx-quickstart command line option --module-first sphinx-apidoc command line option --nitpicky sphinx-build command line option --no-batchfile sphinx-quickstart command line option --no-color sphinx-build command line option --no-headings sphinx-apidoc command line option --no-makefile sphinx-quickstart command line option --no-sep sphinx-quickstart command line option --no-toc sphinx-apidoc command line option --no-use-make-mode sphinx-quickstart command line option --pdb sphinx-build command line option --private sphinx-apidoc command line option --project sphinx-quickstart command line option --quiet sphinx-build command line option sphinx-quickstart command line option --release sphinx-quickstart command line option --remove-old sphinx-apidoc command line option sphinx-autogen command line option --respect-module-all sphinx-autogen command line option --sep sphinx-quickstart command line option --separate sphinx-apidoc command line option --show-traceback sphinx-build command line option

--silent sphinx-build command line option --suffix sphinx-autogen command line option sphinx-quickstart command line option --tag sphinx-build command line option --templatedir sphinx-apidoc command line option sphinx-quickstart command line option --templates sphinx-autogen command line option --tocfile sphinx-apidoc command line option --use-make-mode sphinx-quickstart command line option --verbose sphinx-build command line option --version sphinx-build command line option sphinx-quickstart command line option --warning-file sphinx-build command line option --write-all sphinx-build command line option -A sphinx-apidoc command line option sphinx-build command line option -a sphinx-apidoc command line option sphinx-autogen command line option sphinx-build command line option sphinx-quickstart command line option -b sphinx-build command line option -C sphinx-build command line option -c sphinx-build command line option -D sphinx-build command line option -d sphinx-apidoc command line option sphinx-build command line option sphinx-quickstart command line option -E sphinx-apidoc command line option sphinx-build command line option -e sphinx-apidoc command line option -F sphinx-apidoc command line option -f sphinx-apidoc command line option -H sphinx-apidoc command line option -h sphinx-build command line option sphinx-quickstart command line option -i sphinx-autogen command line option -j sphinx-build command line option -l sphinx-apidoc command line option sphinx-quickstart command line option -M sphinx-apidoc command line option sphinx-build command line option -N sphinx-build command line option -n sphinx-apidoc command line option sphinx-build command line option -o sphinx-apidoc command line option sphinx-autogen command line option -P sphinx-apidoc command line option sphinx-build command line option -p sphinx-quickstart command line option -Q sphinx-build command line option -q sphinx-apidoc command line option sphinx-build command line option sphinx-quickstart command line option -R sphinx-apidoc command line option -r sphinx-quickstart command line option -s sphinx-apidoc command line option sphinx-autogen command line option -T sphinx-apidoc command line option sphinx-build command line option -t sphinx-apidoc command line option sphinx-autogen command line option sphinx-build command line option sphinx-quickstart command line option -V sphinx-apidoc command line option -v sphinx-build command line option sphinx-quickstart command line option -W sphinx-build command line option -w sphinx-build command line option

_

_() (in module sphinx.locale) __() (in module sphinx.locale)

_object_hierarchy_parts() (sphinx.directives.ObjectDescription method) _parser (sphinx.environment.BuildEnvironment.current_document attribute) _toc_entry_name() (sphinx.directives.ObjectDescription method)

A

:abstract: (directive option) py:class (directive) py:method (directive) py:property (directive) :abstractmethod: (directive option) py:method (directive) py:property (directive) :align: (directive option) digraph (directive) graph (directive) graphviz (directive) :alt: (directive option) digraph (directive) graph (directive) graphviz (directive) :annotation: (directive option) autodata (directive) :append: (directive option) literalinclude (directive) :async: (directive option) py:function (directive) py:method (directive) abbr (role) accept_comment() (sphinxcontrib.websupport.storage.StorageBackend method) add() (sphinx.events.EventManager method) add_autodoc_attrgetter() (sphinx.application.Sphinx method) add_autodocumenter() (sphinx.application.Sphinx method) add_builder() (sphinx.application.Sphinx method) add_comment() (sphinxcontrib.websupport.storage.StorageBackend method) (sphinxcontrib.websupport.WebSupport method) add_config_value() (sphinx.application.Sphinx method) add_crossref_type() (sphinx.application.Sphinx method) add_css_file() (sphinx.application.Sphinx method) add_directive() (sphinx.application.Sphinx method) add_directive_to_domain() (sphinx.application.Sphinx method) add_document() (sphinxcontrib.websupport.search.BaseSearch method) add_domain() (sphinx.application.Sphinx method) add_enumerable_node() (sphinx.application.Sphinx method) add_env_collector() (sphinx.application.Sphinx method) add_event() (sphinx.application.Sphinx method) add_function_parentheses configuration value add_generic_role() (sphinx.application.Sphinx method) add_html_math_renderer() (sphinx.application.Sphinx method) add_html_theme() (sphinx.application.Sphinx method) add_index_to_domain() (sphinx.application.Sphinx method) add_js_file() (sphinx.application.Sphinx method) add_latex_package() (sphinx.application.Sphinx method) add_lexer() (sphinx.application.Sphinx method) add_linkcode_domain() (in module sphinx.ext.linkcode) add_message_catalog() (sphinx.application.Sphinx method) add_module_names configuration value add_node() (sphinx.application.Sphinx method) (sphinxcontrib.websupport.storage.StorageBackend method) add_object_type() (sphinx.application.Sphinx method) (sphinx.domains.Domain method) add_post_transform() (sphinx.application.Sphinx method) add_role() (sphinx.application.Sphinx method) add_role_to_domain() (sphinx.application.Sphinx method) add_search_language() (sphinx.application.Sphinx method) add_source_parser() (sphinx.application.Sphinx method) add_source_suffix() (sphinx.application.Sphinx method) add_target_and_index() (sphinx.directives.ObjectDescription method) add_transform() (sphinx.application.Sphinx method) added in version admonition attention caution danger error hint important note tip warning admonition (directive) admonitions after_content() (sphinx.directives.ObjectDescription method) allow_parallel (sphinx.builders.Builder attribute) anchor (sphinx.domains.IndexEntry attribute) any (role) apidoc_automodule_options configuration value apidoc_exclude_patterns configuration value apidoc_follow_links configuration value apidoc_implicit_namespaces configuration value apidoc_include_private configuration value apidoc_max_depth configuration value apidoc_module_first configuration value apidoc_modules configuration value apidoc_no_headings configuration value apidoc_separate_modules configuration value app (sphinx.environment.BuildEnvironment attribute) (sphinx.transforms.SphinxTransform property) applehelp_bundle_id configuration value applehelp_bundle_name configuration value applehelp_bundle_version configuration value applehelp_codesign_flags configuration value applehelp_codesign_identity configuration value applehelp_codesign_path configuration value applehelp_dev_region configuration value applehelp_disable_external_tools configuration value applehelp_icon configuration value applehelp_index_anchors configuration value applehelp_indexer_path configuration value applehelp_kb_product configuration value

applehelp_kb_url configuration value applehelp_locale configuration value applehelp_min_term_length configuration value applehelp_remote_url configuration value applehelp_stopwords configuration value applehelp_title configuration value AppleHelpBuilder (class in sphinxcontrib.applehelp) apply() (sphinx.transforms.post_transforms.SphinxPostTransform method) arguments (docutils.parsers.rst.Directive attribute) attention admonition attention (directive) attributes (built-in variable) author configuration value autoattribute (directive) autoclass (directive) :class-doc-from: (directive option) :exclude-members: (directive option) :inherited-members: (directive option) :member-order: (directive option) :members: (directive option) :no-index-entry: (directive option) :no-index: (directive option) :private-members: (directive option) :show-inheritance: (directive option) :special-members: (directive option) :undoc-members: (directive option) autoclass_content configuration value autodata (directive) :annotation: (directive option) :no-index-entry: (directive option) :no-index: (directive option) :no-value: (directive option) autodecorator (directive) autodoc-before-process-signature event autodoc-process-bases event autodoc-process-docstring event autodoc-process-signature event autodoc-skip-member event autodoc_class_signature configuration value autodoc_default_options configuration value autodoc_docstring_signature configuration value autodoc_inherit_docstrings configuration value autodoc_member_order configuration value autodoc_mock_imports configuration value autodoc_preserve_defaults configuration value autodoc_type_aliases configuration value autodoc_typehints configuration value autodoc_typehints_description_target configuration value autodoc_typehints_format configuration value autodoc_use_type_comments configuration value autodoc_warningiserror configuration value autoexception (directive) autofunction (directive) :no-index-entry: (directive option) :no-index: (directive option) automatic documentation, [1] linking testing automethod (directive) automodule (directive) :deprecated: (directive option) :exclude-members: (directive option) :ignore-module-all: (directive option) :imported-members: (directive option) :member-order: (directive option) :members: (directive option) :no-index-entry: (directive option) :no-index: (directive option) :platform: (directive option) :private-members: (directive option) :show-inheritance: (directive option) :special-members: (directive option) :synopsis: (directive option) :undoc-members: (directive option) autoproperty (directive) autosectionlabel_maxdepth configuration value autosectionlabel_prefix_document configuration value autosummary (directive) :caption: (directive option) :class: (directive option) :nosignatures: (directive option) :recursive: (directive option) :signatures: (directive option) :template: (directive option) :toctree: (directive option) autosummary_context configuration value autosummary_filename_map configuration value autosummary_generate configuration value autosummary_generate_overwrite configuration value autosummary_ignore_module_all configuration value autosummary_imported_members configuration value autosummary_mock_imports configuration value available (sphinx.transforms.post_transforms.images.ImageConverter attribute)

B

BaseSearch (class in sphinxcontrib.websupport.search) before_content() (sphinx.directives.ObjectDescription method) between() (in module sphinx.ext.autodoc) block_text (docutils.parsers.rst.Directive attribute) body (built-in variable) build() (sphinx.builders.Builder method) (sphinxcontrib.websupport.WebSupport method) build-finished event build_all() (sphinx.builders.Builder method) build_specific() (sphinx.builders.Builder method) build_update() (sphinx.builders.Builder method) BuildEnvironment (class in sphinx.environment)

builder (built-in variable) Builder (class in sphinx.builders) builder-inited event built-in function enumerate() escape() hasdoc() pathto() relbar() sidebar() warning()

C

:canonical: (directive option) py:attribute (directive) py:class (directive) py:data (directive) py:function (directive) py:method (directive) py:type (directive) :caption: (directive option) autosummary (directive) code-block (directive) digraph (directive) graph (directive) graphviz (directive) literalinclude (directive) toctree (directive) :class-doc-from: (directive option) autoclass (directive) :class: (directive option) autosummary (directive) code-block (directive) digraph (directive) graph (directive) graphviz (directive) literalinclude (directive) math (directive) rubric (directive) toctree (directive) :classmethod: (directive option) py:method (directive) py:property (directive) :columns: (directive option) hlist (directive) c:alias (directive) :maxdepth: (directive option) :noroot: (directive option) c:data (role) c:enum (directive) (role) c:enumerator (directive) (role) c:expr (role) c:func (role) c:function (directive) :single-line-parameter-list: (directive option) c:macro (directive) :single-line-parameter-list: (directive option) c:macro (role) c:member (directive) (role) c:namespace (directive) c:namespace-pop (directive) c:namespace-push (directive) c:struct (directive) (role) c:texpr (role) c:type (directive) (role) c:union (directive) (role) c:var (directive) (role) c_extra_keywords configuration value c_id_attributes configuration value c_maximum_signature_line_length configuration value c_paren_attributes configuration value category (sphinx.errors.SphinxError attribute) caution admonition caution (directive) centered (directive) changes in version ChangesBuilder (class in sphinx.builders.changes) check_consistency() (sphinx.domains.Domain method) CheckExternalLinksBuilder (class in sphinx.builders.linkcheck) class (built-in variable) classes (built-in variable) clear_doc() (sphinx.domains.Domain method) (sphinx.environment.collectors.EnvironmentCollector method) code examples code (directive) (role) code-block (directive) :caption: (directive option) :class: (directive option) :dedent: (directive option) :emphasize-lines: (directive option) :force: (directive option) :lineno-start: (directive option) :linenos: (directive option) :name: (directive option) codeauthor (directive) command (role) Common Vulnerabilities and Exposures CVE 2020-10735 Common Weakness Enumeration CWE 787 compact_paragraph (class in sphinx.addnodes) conf module confdir (sphinx.application.Sphinx attribute) Config (class in sphinx.config) config (sphinx.environment.BuildEnvironment attribute) (sphinx.parsers.Parser attribute) (sphinx.transforms.SphinxTransform property) (sphinx.util.docutils.SphinxDirective property) (sphinx.util.docutils.SphinxRole property) config-inited event ConfigError configuration directory configuration value add_function_parentheses add_module_names apidoc_automodule_options apidoc_exclude_patterns apidoc_follow_links apidoc_implicit_namespaces apidoc_include_private apidoc_max_depth apidoc_module_first apidoc_modules apidoc_no_headings apidoc_separate_modules applehelp_bundle_id applehelp_bundle_name applehelp_bundle_version applehelp_codesign_flags applehelp_codesign_identity applehelp_codesign_path applehelp_dev_region applehelp_disable_external_tools applehelp_icon applehelp_index_anchors applehelp_indexer_path applehelp_kb_product applehelp_kb_url applehelp_locale applehelp_min_term_length applehelp_remote_url applehelp_stopwords applehelp_title author autoclass_content autodoc_class_signature autodoc_default_options autodoc_docstring_signature autodoc_inherit_docstrings autodoc_member_order autodoc_mock_imports autodoc_preserve_defaults autodoc_type_aliases autodoc_typehints autodoc_typehints_description_target autodoc_typehints_format autodoc_use_type_comments autodoc_warningiserror autosectionlabel_maxdepth autosectionlabel_prefix_document autosummary_context autosummary_filename_map autosummary_generate autosummary_generate_overwrite autosummary_ignore_module_all autosummary_imported_members autosummary_mock_imports c_extra_keywords c_id_attributes c_maximum_signature_line_length c_paren_attributes copyright coverage_c_path coverage_c_regexes coverage_ignore_c_items coverage_ignore_classes coverage_ignore_functions coverage_ignore_modules coverage_ignore_pyobjects coverage_modules coverage_show_missing_items coverage_skip_undoc_in_source coverage_statistics_to_report coverage_statistics_to_stdout coverage_write_headline cpp_id_attributes cpp_index_common_prefix cpp_maximum_signature_line_length cpp_paren_attributes default_role doctest_default_flags doctest_fail_fast doctest_global_cleanup doctest_global_setup doctest_path doctest_show_successes doctest_test_doctest_blocks epub_author epub_basename epub_contributor epub_copyright epub_cover epub_css_files epub_description epub_exclude_files epub_fix_images epub_guide epub_identifier epub_language epub_max_image_width epub_post_files epub_pre_files epub_publisher epub_scheme epub_show_urls epub_theme epub_theme_options epub_title epub_tocdepth epub_tocdup epub_tocscope epub_uid epub_use_index epub_writing_mode exclude_patterns extensions extlinks extlinks_detect_hardcoded_links figure_language_filename gettext_additional_targets gettext_allow_fuzzy_translations gettext_auto_build gettext_compact gettext_location gettext_uuid graphviz_dot graphviz_dot_args graphviz_output_format highlight_language highlight_options html_additional_pages html_baseurl html_codeblock_linenos_style html_compact_lists html_context html_copy_source html_css_files html_domain_indices html_extra_path html_favicon html_file_suffix html_js_files html_last_updated_fmt html_last_updated_use_utc html_link_suffix html_logo html_math_renderer html_output_encoding html_permalinks html_permalinks_icon html_scaled_image_link html_search_language html_search_options html_search_scorer html_secnumber_suffix html_short_title html_show_copyright html_show_search_summary html_show_sourcelink html_show_sphinx html_sidebars html_sourcelink_suffix html_split_index html_static_path html_style html_theme html_theme_options html_theme_path html_title html_use_index html_use_opensearch htmlhelp_basename htmlhelp_file_suffix htmlhelp_link_suffix image_converter image_converter_args imgmath_add_tooltips imgmath_dvipng imgmath_dvipng_args imgmath_dvisvgm imgmath_dvisvgm_args imgmath_embed imgmath_font_size imgmath_image_format imgmath_latex imgmath_latex_args imgmath_latex_preamble imgmath_use_preview include_patterns inheritance_alias inheritance_edge_attrs inheritance_graph_attrs inheritance_node_attrs intersphinx_cache_limit intersphinx_disabled_reftypes intersphinx_mapping intersphinx_resolve_self intersphinx_timeout javascript_maximum_signature_line_length javascript_trailing_comma_in_multi_line_signatures jsmath_path keep_warnings language latex_additional_files latex_appendices latex_docclass latex_documents latex_domain_indices latex_elements latex_engine latex_logo latex_show_pagerefs latex_show_urls latex_table_style latex_theme latex_theme_options latex_theme_path latex_toplevel_sectioning latex_use_latex_multicolumn latex_use_xindy linkcheck_allow_unauthorized linkcheck_allowed_redirects linkcheck_anchors linkcheck_anchors_ignore linkcheck_anchors_ignore_for_url linkcheck_auth linkcheck_exclude_documents linkcheck_ignore linkcheck_rate_limit_timeout linkcheck_report_timeouts_as_broken linkcheck_request_headers linkcheck_retries linkcheck_timeout linkcheck_workers linkcode_resolve locale_dirs man_make_section_directory man_pages man_show_urls manpages_url master_doc math_eqref_format math_number_all math_numfig math_numsep mathjax2_config mathjax3_config mathjax_config mathjax_options mathjax_path maximum_signature_line_length modindex_common_prefix napoleon_attr_annotations napoleon_custom_sections napoleon_google_docstring napoleon_include_init_with_doc napoleon_include_private_with_doc napoleon_include_special_with_doc napoleon_numpy_docstring napoleon_preprocess_types napoleon_type_aliases napoleon_use_admonition_for_examples napoleon_use_admonition_for_notes napoleon_use_admonition_for_references napoleon_use_ivar napoleon_use_keyword napoleon_use_param napoleon_use_rtype needs_extensions needs_sphinx nitpick_ignore nitpick_ignore_regex nitpicky numfig numfig_format numfig_secnum_depth option_emphasise_placeholders primary_domain project project_copyright pygments_style python_display_short_literal_types python_maximum_signature_line_length python_trailing_comma_in_multi_line_signatures python_use_unqualified_type_names qthelp_basename qthelp_namespace qthelp_theme qthelp_theme_options release root_doc rst_epilog rst_prolog show_authors show_warning_types singlehtml_sidebars smartquotes smartquotes_action smartquotes_excludes source_encoding source_suffix strip_signature_backslash suppress_warnings template_bridge templates_path texinfo_appendices texinfo_cross_references texinfo_documents texinfo_domain_indices texinfo_elements texinfo_no_detailmenu texinfo_show_urls text_add_secnumbers text_newlines text_secnumber_suffix text_sectionchars the_answer tls_cacerts tls_verify toc_object_entries toc_object_entries_show_parents today today_fmt todo_emit_warnings todo_include_todos todo_link_only translation_progress_classes trim_doctest_flags trim_footnote_reference_space user_agent version viewcode_enable_epub viewcode_follow_imported_members viewcode_line_numbers xml_pretty

confval (directive) :default: (directive option) :type: (directive option) confval (role) connect() (sphinx.application.Sphinx method) (sphinx.events.EventManager method) content (docutils.parsers.rst.Directive attribute) (sphinx.util.docutils.SphinxRole attribute) content_offset (docutils.parsers.rst.Directive attribute) contents table of conversion_rules (sphinx.transforms.post_transforms.images.ImageConverter attribute) convert() (sphinx.transforms.post_transforms.images.ImageConverter method) copy_assets() (sphinx.builders.Builder method) copyright configuration value copyright (built-in variable) coverage_c_path configuration value coverage_c_regexes configuration value coverage_ignore_c_items configuration value coverage_ignore_classes configuration value coverage_ignore_functions configuration value coverage_ignore_modules configuration value coverage_ignore_pyobjects configuration value coverage_modules configuration value coverage_show_missing_items configuration value coverage_skip_undoc_in_source configuration value coverage_statistics_to_report configuration value coverage_statistics_to_stdout configuration value coverage_write_headline configuration value CoverageBuilder (class in sphinx.ext.coverage) cpp:alias (directive) :maxdepth: (directive option) :noroot: (directive option) cpp:any (role) cpp:class (directive) (role) cpp:concept (directive) (role) cpp:enum (directive) (role) cpp:enum-class (directive) cpp:enum-struct (directive) cpp:enumerator (directive) (role) cpp:expr (role) cpp:func (role) cpp:function (directive) :single-line-parameter-list: (directive option) cpp:member (directive) (role) cpp:namespace (directive) cpp:namespace-pop (directive) cpp:namespace-push (directive) cpp:struct (directive) (role) cpp:texpr (role) cpp:type (directive) (role) cpp:union (directive) cpp:var (directive) (role) cpp_id_attributes configuration value cpp_index_common_prefix configuration value cpp_maximum_signature_line_length configuration value cpp_paren_attributes configuration value critical() (sphinx.util.logging.SphinxLoggerAdapter method) current_document (sphinx.environment.BuildEnvironment attribute) CustomList (C++ type) cut_lines() (in module sphinx.ext.autodoc) cve (role) cwe (role)

D

:dedent: (directive option) code-block (directive) literalinclude (directive) :default: (directive option) confval (directive) :deprecated: (directive option) automodule (directive) py:module (directive) :diff: (directive option) literalinclude (directive) danger admonition danger (directive) dangling_warnings (sphinx.domains.Domain attribute) data (sphinx.domains.Domain attribute) data_version (sphinx.domains.Domain attribute) debug() (sphinx.util.logging.SphinxLoggerAdapter method) default domain role default-domain (directive) default_domain (sphinx.environment.BuildEnvironment.current_document attribute) default_priority (sphinx.transforms.post_transforms.images.ImageConverter attribute) default_role configuration value default_role (sphinx.environment.BuildEnvironment.current_document attribute) default_translator_class (sphinx.builders.Builder attribute) delete_comment() (sphinxcontrib.websupport.storage.StorageBackend method) deprecated (directive) desc (class in sphinx.addnodes) desc_addname (class in sphinx.addnodes) desc_annotation (class in sphinx.addnodes) desc_content (class in sphinx.addnodes) desc_inline (class in sphinx.addnodes) desc_name (class in sphinx.addnodes) desc_optional (class in sphinx.addnodes) desc_parameter (class in sphinx.addnodes) desc_parameterlist (class in sphinx.addnodes) desc_returns (class in sphinx.addnodes) desc_sig_element (class in sphinx.addnodes) desc_sig_keyword (class in sphinx.addnodes) desc_sig_keyword_type (class in sphinx.addnodes) desc_sig_literal_char (class in sphinx.addnodes) desc_sig_literal_number (class in sphinx.addnodes) desc_sig_literal_string (class in sphinx.addnodes) desc_sig_name (class in sphinx.addnodes) desc_sig_operator (class in sphinx.addnodes) desc_sig_punctuation (class in sphinx.addnodes) desc_sig_space (class in sphinx.addnodes) desc_signature (class in sphinx.addnodes) desc_signature_line (class in sphinx.addnodes) desc_type (class in sphinx.addnodes) descr (sphinx.domains.IndexEntry attribute) describe (directive) DevhelpBuilder (class in sphinxcontrib.devhelp) dfn (role) digraph (directive) :align: (directive option) :alt: (directive option) :caption: (directive option) :class: (directive option) :layout: (directive option) :name: (directive option)

directive Directive (class in docutils.parsers.rst) directive() (sphinx.domains.Domain method) directives (sphinx.domains.Domain attribute) DirectoryHTMLBuilder (class in sphinx.builders.dirhtml) disabled (sphinx.util.docutils.ReferenceRole attribute) disconnect() (sphinx.application.Sphinx method) (sphinx.events.EventManager method) discover() (sphinx.project.Project method) display_toc (built-in variable) doc (role) doc2path() (sphinx.environment.BuildEnvironment method) (sphinx.project.Project method) docname (sphinx.domains.IndexEntry attribute) (sphinx.environment.BuildEnvironment attribute) (sphinx.environment.BuildEnvironment.current_document attribute) docnames (sphinx.project.Project attribute) docstitle (built-in variable) docstring doctest doctest (directive) :hide: (directive option) :no-trim-doctest-flags: (directive option) :options: (directive option) :pyversion: (directive option) :skipif: (directive option) :trim-doctest-flags: (directive option) doctest_default_flags configuration value doctest_fail_fast configuration value doctest_global_cleanup configuration value doctest_global_setup configuration value doctest_path configuration value doctest_show_successes configuration value doctest_test_doctest_blocks configuration value doctree-read event doctree-resolved event doctreedir (sphinx.application.Sphinx attribute) (sphinx.environment.BuildEnvironment attribute) document name documentation automatic, [1] generate generation docutils.parsers.rst module docutils_version_info (built-in variable) domain default Domain (class in sphinx.domains) download (role) download_reference (class in sphinx.addnodes) DummyBuilder (class in sphinx.builders.dummy)

E

:emphasize-lines: (directive option) code-block (directive) literalinclude (directive) :encoding: (directive option) literalinclude (directive) :end-at: (directive option) literalinclude (directive) :end-before: (directive option) literalinclude (directive) :exclude-members: (directive option) autoclass (directive) automodule (directive) embedded (built-in variable) emit() (sphinx.application.Sphinx method) (sphinx.events.EventManager method) emit_firstresult() (sphinx.application.Sphinx method) (sphinx.events.EventManager method) ENUM (class in sphinx.config) enumerable_nodes (sphinx.domains.Domain attribute) enumerate() built-in function env (sphinx.parsers.Parser attribute) (sphinx.transforms.SphinxTransform property) (sphinx.util.docutils.SphinxDirective property) (sphinx.util.docutils.SphinxRole property) env-before-read-docs event env-check-consistency event env-get-outdated event env-get-updated event env-merge-info event env-purge-doc event env-updated event env_version (sphinx.util.typing.ExtensionMetadata attribute) environment environment variable python:PYTHONWARNINGS SPHINX_APIDOC_OPTIONS EnvironmentCollector (class in sphinx.environment.collectors) envvar (directive) (role) epilog (sphinx.builders.Builder attribute) Epub3Builder (class in sphinx.builders.epub3) epub_author configuration value epub_basename configuration value epub_contributor configuration value epub_copyright configuration value epub_cover configuration value epub_css_files configuration value epub_description configuration value epub_exclude_files configuration value epub_fix_images configuration value epub_guide configuration value epub_identifier configuration value epub_language configuration value epub_max_image_width configuration value epub_post_files configuration value epub_pre_files configuration value epub_publisher configuration value

epub_scheme configuration value epub_show_urls configuration value epub_theme configuration value epub_theme_options configuration value epub_title configuration value epub_tocdepth configuration value epub_tocdup configuration value epub_tocscope configuration value epub_uid configuration value epub_use_index configuration value epub_writing_mode configuration value eq (role) error admonition error (directive) error() (sphinx.util.logging.SphinxLoggerAdapter method) escape() built-in function event autodoc-before-process-signature autodoc-process-bases autodoc-process-docstring autodoc-process-signature autodoc-skip-member build-finished builder-inited config-inited doctree-read doctree-resolved env-before-read-docs env-check-consistency env-get-outdated env-get-updated env-merge-info env-purge-doc env-updated html-collect-pages html-page-context include-read linkcheck-process-uri missing-reference object-description-transform source-read todo-defined viewcode-find-source viewcode-follow-imported warn-missing-reference write-started EventManager (class in sphinx.events) events (sphinx.builders.Builder attribute) (sphinx.environment.BuildEnvironment attribute) examples code exceptions (built-in variable) exclude_patterns configuration value extension ExtensionError, [1] ExtensionMetadata (class in sphinx.util.typing) extensions configuration value external (role) extlinks configuration value extlinks_detect_hardcoded_links configuration value extra (sphinx.domains.IndexEntry attribute) extract_context() (sphinxcontrib.websupport.search.BaseSearch method)

F

:final: (directive option) py:class (directive) py:exception (directive) py:method (directive) :force: (directive option) code-block (directive) highlight (directive) literalinclude (directive) favicon_url (built-in variable) feed() (sphinxcontrib.websupport.search.BaseSearch method) figure_language_filename configuration value file (role) file_suffix (built-in variable) final_argument_whitespace (docutils.parsers.rst.Directive attribute) (sphinx.directives.ObjectDescription attribute) finish() (sphinx.builders.Builder method) finish_indexing() (sphinxcontrib.websupport.search.BaseSearch method) format (sphinx.builders.Builder attribute) (sphinx.builders.changes.ChangesBuilder attribute) (sphinx.builders.dirhtml.DirectoryHTMLBuilder attribute) (sphinx.builders.epub3.Epub3Builder attribute) (sphinx.builders.gettext.MessageCatalogBuilder attribute) (sphinx.builders.html.StandaloneHTMLBuilder attribute) (sphinx.builders.latex.LaTeXBuilder attribute) (sphinx.builders.linkcheck.CheckExternalLinksBuilder attribute) (sphinx.builders.manpage.ManualPageBuilder attribute) (sphinx.builders.singlehtml.SingleFileHTMLBuilder attribute) (sphinx.builders.texinfo.TexinfoBuilder attribute) (sphinx.builders.text.TextBuilder attribute) (sphinx.builders.xml.PseudoXMLBuilder attribute) (sphinx.builders.xml.XMLBuilder attribute) (sphinxcontrib.applehelp.AppleHelpBuilder attribute) (sphinxcontrib.devhelp.DevhelpBuilder attribute) (sphinxcontrib.htmlhelp.HTMLHelpBuilder attribute) (sphinxcontrib.qthelp.QtHelpBuilder attribute) (sphinxcontrib.serializinghtml.JSONHTMLBuilder attribute) (sphinxcontrib.serializinghtml.PickleHTMLBuilder attribute)

found_docs (sphinx.environment.BuildEnvironment attribute) fresh_env_used (sphinx.application.Sphinx attribute) fullname (built-in variable) functions (built-in variable)

G

:glob: (directive option) toctree (directive) generate documentation generate() (sphinx.domains.Index method) generation documentation genindex toctree get_data() (sphinxcontrib.websupport.storage.StorageBackend method) (sphinxcontrib.websupport.WebSupport method) get_document() (sphinxcontrib.websupport.WebSupport method) get_enumerable_node_type() (sphinx.domains.Domain method) get_full_qualified_name() (sphinx.domains.Domain method) get_location() (sphinx.util.docutils.SphinxDirective method) (sphinx.util.docutils.SphinxRole method) get_objects() (sphinx.domains.Domain method) get_outdated_docs() (sphinx.builders.Builder method) (sphinx.environment.collectors.EnvironmentCollector method) get_relative_uri() (sphinx.builders.Builder method) get_search_results() (sphinxcontrib.websupport.WebSupport method) get_signatures() (sphinx.directives.ObjectDescription method) get_source_info() (sphinx.util.docutils.SphinxDirective method) get_target_uri() (sphinx.builders.Builder method) get_translation() (in module sphinx.locale) get_type_name() (sphinx.domains.Domain method) get_updated_docs() (sphinx.environment.collectors.EnvironmentCollector method) getLogger() (in module sphinx.util.logging) gettext_additional_targets configuration value gettext_allow_fuzzy_translations configuration value gettext_auto_build configuration value

gettext_compact configuration value gettext_location configuration value gettext_uuid configuration value global substitutions, [1], [2] globalcontext_filename (sphinxcontrib.serializinghtml.SerializingHTMLBuilder attribute) glossary (class in sphinx.addnodes) glossary (directive) :sorted: (directive option) graph (directive) :align: (directive option) :alt: (directive option) :caption: (directive option) :class: (directive option) :layout: (directive option) :name: (directive option) graphviz (directive) :align: (directive option) :alt: (directive option) :caption: (directive option) :class: (directive option) :layout: (directive option) :name: (directive option) graphviz_dot configuration value graphviz_dot_args configuration value graphviz_output_format configuration value guilabel (role)

H

:heading-level: (directive option) rubric (directive) :hidden: (directive option) toctree (directive) :hide: (directive option) doctest (directive) testcode (directive) testoutput (directive) handle_query() (sphinxcontrib.websupport.search.BaseSearch method) handle_signature() (sphinx.directives.ObjectDescription method) has_content (docutils.parsers.rst.Directive attribute) (sphinx.directives.ObjectDescription attribute) has_explicit_title (sphinx.util.docutils.ReferenceRole attribute) has_source (built-in variable) hasdoc() built-in function highlight (directive) :force: (directive option) :linenothreshold: (directive option) highlight_language configuration value highlight_language (sphinx.environment.BuildEnvironment.current_document attribute) highlight_options configuration value highlightlang (class in sphinx.addnodes) hint admonition hint (directive) hlist (directive) :columns: (directive option) html-collect-pages event html-page-context event html_additional_pages configuration value html_baseurl configuration value html_codeblock_linenos_style configuration value html_compact_lists configuration value html_context configuration value html_copy_source configuration value html_css_files configuration value html_domain_indices configuration value html_extra_path configuration value html_favicon configuration value html_file_suffix configuration value html_js_files configuration value html_last_updated_fmt configuration value html_last_updated_use_utc configuration value

html_link_suffix configuration value html_logo configuration value html_math_renderer configuration value html_output_encoding configuration value html_permalinks configuration value html_permalinks_icon configuration value html_scaled_image_link configuration value html_search_language configuration value html_search_options configuration value html_search_scorer configuration value html_secnumber_suffix configuration value html_short_title configuration value html_show_copyright configuration value html_show_search_summary configuration value html_show_sourcelink configuration value html_show_sphinx configuration value html_sidebars configuration value html_sourcelink_suffix configuration value html_split_index configuration value html_static_path configuration value html_style configuration value html_theme configuration value html_theme_options configuration value html_theme_path configuration value html_title configuration value html_use_index configuration value html_use_opensearch configuration value htmlhelp_basename configuration value htmlhelp_file_suffix configuration value htmlhelp_link_suffix configuration value HTMLHelpBuilder (class in sphinxcontrib.htmlhelp)

I

:ignore-module-all: (directive option) automodule (directive) :imported-members: (directive option) automodule (directive) :include-subclasses: (directive option) inheritance-diagram (directive) :includehidden: (directive option) toctree (directive) :inherited-members: (directive option) autoclass (directive) ifconfig (directive) image_converter configuration value image_converter_args configuration value ImageConverter (class in sphinx.transforms.post_transforms.images) imgmath_add_tooltips configuration value imgmath_dvipng configuration value imgmath_dvipng_args configuration value imgmath_dvisvgm configuration value imgmath_dvisvgm_args configuration value imgmath_embed configuration value imgmath_font_size configuration value imgmath_image_format configuration value imgmath_latex configuration value imgmath_latex_args configuration value imgmath_latex_preamble configuration value imgmath_use_preview configuration value implementation (sphinxcontrib.serializinghtml.SerializingHTMLBuilder attribute) important admonition important (directive) in version added changes removed

include-read event include_patterns configuration value index (class in sphinx.addnodes) Index (class in sphinx.domains) index (directive) :name: (directive option) index (role) IndexEntry (class in sphinx.domains) indices (sphinx.domains.Domain attribute) info() (sphinx.util.logging.SphinxLoggerAdapter method) inheritance-diagram (directive) :include-subclasses: (directive option) inheritance_alias configuration value inheritance_edge_attrs configuration value inheritance_graph_attrs configuration value inheritance_node_attrs configuration value inherited_members (built-in variable) init() (in module sphinx.locale) (sphinx.application.TemplateBridge method) (sphinx.builders.Builder method) init_console() (in module sphinx.locale) init_indexing() (sphinxcontrib.websupport.search.BaseSearch method) initial_data (sphinx.domains.Domain attribute) inliner (sphinx.util.docutils.SphinxRole attribute) intersphinx_cache_limit configuration value intersphinx_disabled_reftypes configuration value intersphinx_mapping configuration value intersphinx_resolve_self configuration value intersphinx_timeout configuration value is_available() (sphinx.transforms.post_transforms.images.ImageConverter method) is_parallel_allowed() (sphinx.application.Sphinx method) is_supported() (sphinx.transforms.post_transforms.SphinxPostTransform method)

J

javascript_maximum_signature_line_length configuration value javascript_trailing_comma_in_multi_line_signatures configuration value js:attr (role) js:attribute (directive) js:class (directive) :single-line-parameter-list: (directive option) js:class (role) js:data (directive) (role)

js:func (role) js:function (directive) :single-line-parameter-list: (directive option) js:meth (role) js:method (directive) :single-line-parameter-list: (directive option) js:mod (role) js:module (directive) jsmath_path configuration value JSONHTMLBuilder (class in sphinxcontrib.serializinghtml)

K

kbd (role) keep_warnings configuration value

keyword (role)

L

:label: (directive option) math (directive) :language: (directive option) literalinclude (directive) :layout: (directive option) digraph (directive) graph (directive) graphviz (directive) :lineno-match: (directive option) literalinclude (directive) :lineno-start: (directive option) code-block (directive) literalinclude (directive) :linenos: (directive option) code-block (directive) literalinclude (directive) :linenothreshold: (directive option) highlight (directive) :lines: (directive option) literalinclude (directive) label (sphinx.domains.Domain attribute) language configuration value language (built-in variable) last_updated (built-in variable) latex module latex_additional_files configuration value latex_appendices configuration value latex_docclass configuration value latex_documents configuration value latex_domain_indices configuration value latex_elements configuration value latex_engine configuration value latex_logo configuration value latex_show_pagerefs configuration value latex_show_urls configuration value latex_table_style configuration value latex_theme configuration value latex_theme_options configuration value latex_theme_path configuration value latex_toplevel_sectioning configuration value latex_use_latex_multicolumn configuration value latex_use_xindy configuration value LaTeXBuilder (class in sphinx.builders.latex)

lineno (docutils.parsers.rst.Directive attribute) (sphinx.util.docutils.SphinxRole attribute) linkcheck-process-uri event linkcheck_allow_unauthorized configuration value linkcheck_allowed_redirects configuration value linkcheck_anchors configuration value linkcheck_anchors_ignore configuration value linkcheck_anchors_ignore_for_url configuration value linkcheck_auth configuration value linkcheck_exclude_documents configuration value linkcheck_ignore configuration value linkcheck_rate_limit_timeout configuration value linkcheck_report_timeouts_as_broken configuration value linkcheck_request_headers configuration value linkcheck_retries configuration value linkcheck_timeout configuration value linkcheck_workers configuration value linkcode_resolve configuration value linking automatic literal_emphasis (class in sphinx.addnodes) literalinclude (directive) :append: (directive option) :caption: (directive option) :class: (directive option) :dedent: (directive option) :diff: (directive option) :emphasize-lines: (directive option) :encoding: (directive option) :end-at: (directive option) :end-before: (directive option) :force: (directive option) :language: (directive option) :lineno-match: (directive option) :lineno-start: (directive option) :linenos: (directive option) :lines: (directive option) :name: (directive option) :prepend: (directive option) :pyobject: (directive option) :start-after: (directive option) :start-at: (directive option) :tab-width: (directive option) locale_dirs configuration value log() (sphinx.util.logging.SphinxLoggerAdapter method) logo_url (built-in variable)

M

:maxdepth: (directive option) c:alias (directive) cpp:alias (directive) :member-order: (directive option) autoclass (directive) automodule (directive) :members: (directive option) autoclass (directive) automodule (directive) mailheader (role) makevar (role) man_make_section_directory configuration value man_pages configuration value man_show_urls configuration value manpage (role) manpages_url configuration value ManualPageBuilder (class in sphinx.builders.manpage) master document master_doc configuration value master_doc (built-in variable) math (directive) :class: (directive option) :label: (directive option) :name: (directive option) :no-wrap: (directive option) math (role) math:numref (role) math_eqref_format configuration value math_number_all configuration value math_numfig configuration value math_numsep configuration value mathjax2_config configuration value mathjax3_config configuration value mathjax_config configuration value mathjax_options configuration value mathjax_path configuration value maximum_signature_line_length configuration value members (built-in variable) menuselection (role) merge_domaindata() (sphinx.domains.Domain method) merge_other() (sphinx.environment.collectors.EnvironmentCollector method) MessageCatalogBuilder (class in sphinx.builders.gettext) meta (built-in variable) metadata (sphinx.environment.BuildEnvironment attribute) metatags (built-in variable) methods (built-in variable) mimetype (role)

missing-reference event modindex toctree modindex_common_prefix configuration value module conf docutils.parsers.rst latex sphinx.addnodes sphinx.application sphinx.builders sphinx.builders.changes sphinx.builders.dirhtml sphinx.builders.dummy sphinx.builders.epub3 sphinx.builders.gettext sphinx.builders.html sphinx.builders.latex sphinx.builders.linkcheck sphinx.builders.manpage sphinx.builders.singlehtml sphinx.builders.texinfo sphinx.builders.text sphinx.builders.xml sphinx.directives sphinx.domains sphinx.domains.python sphinx.environment sphinx.environment.collectors sphinx.errors sphinx.ext.apidoc sphinx.ext.autodoc sphinx.ext.autosectionlabel sphinx.ext.autosummary sphinx.ext.coverage sphinx.ext.doctest sphinx.ext.duration sphinx.ext.extlinks sphinx.ext.githubpages sphinx.ext.graphviz sphinx.ext.ifconfig sphinx.ext.imgconverter sphinx.ext.imgmath sphinx.ext.inheritance_diagram sphinx.ext.intersphinx sphinx.ext.jsmath sphinx.ext.linkcode sphinx.ext.mathbase sphinx.ext.mathjax sphinx.ext.napoleon sphinx.ext.todo sphinx.ext.viewcode sphinx.parsers sphinx.testing sphinxcontrib.applehelp sphinxcontrib.devhelp sphinxcontrib.htmlhelp sphinxcontrib.qthelp module (built-in variable) modules (built-in variable) (sphinx.domains.python.PythonDomain attribute)

N

:name: (directive option) code-block (directive) digraph (directive) graph (directive) graphviz (directive) index (directive) literalinclude (directive) math (directive) rubric (directive) toctree (directive) :no-index-entry: (directive option) autoclass (directive) autodata (directive) autofunction (directive) automodule (directive) :no-index: (directive option) autoclass (directive) autodata (directive) autofunction (directive) automodule (directive) :no-trim-doctest-flags: (directive option) doctest (directive) testcode (directive) testoutput (directive) :no-value: (directive option) autodata (directive) :no-wrap: (directive option) math (directive) :noroot: (directive option) c:alias (directive) cpp:alias (directive) :nosignatures: (directive option) autosummary (directive) :numbered: (directive option) toctree (directive) name (built-in variable) (docutils.parsers.rst.Directive attribute) (sphinx.builders.Builder attribute) (sphinx.builders.changes.ChangesBuilder attribute) (sphinx.builders.dirhtml.DirectoryHTMLBuilder attribute) (sphinx.builders.dummy.DummyBuilder attribute) (sphinx.builders.epub3.Epub3Builder attribute) (sphinx.builders.gettext.MessageCatalogBuilder attribute) (sphinx.builders.html.StandaloneHTMLBuilder attribute) (sphinx.builders.latex.LaTeXBuilder attribute) (sphinx.builders.linkcheck.CheckExternalLinksBuilder attribute) (sphinx.builders.manpage.ManualPageBuilder attribute) (sphinx.builders.singlehtml.SingleFileHTMLBuilder attribute) (sphinx.builders.texinfo.TexinfoBuilder attribute) (sphinx.builders.text.TextBuilder attribute) (sphinx.builders.xml.PseudoXMLBuilder attribute) (sphinx.builders.xml.XMLBuilder attribute) (sphinx.domains.Domain attribute) (sphinx.domains.IndexEntry attribute) (sphinx.util.docutils.SphinxRole attribute) (sphinxcontrib.applehelp.AppleHelpBuilder attribute) (sphinxcontrib.devhelp.DevhelpBuilder attribute) (sphinxcontrib.htmlhelp.HTMLHelpBuilder attribute) (sphinxcontrib.qthelp.QtHelpBuilder attribute) (sphinxcontrib.serializinghtml.JSONHTMLBuilder attribute) (sphinxcontrib.serializinghtml.PickleHTMLBuilder attribute)

napoleon_attr_annotations configuration value napoleon_custom_sections configuration value napoleon_google_docstring configuration value napoleon_include_init_with_doc configuration value napoleon_include_private_with_doc configuration value napoleon_include_special_with_doc configuration value napoleon_numpy_docstring configuration value napoleon_preprocess_types configuration value napoleon_type_aliases configuration value napoleon_use_admonition_for_examples configuration value napoleon_use_admonition_for_notes configuration value napoleon_use_admonition_for_references configuration value napoleon_use_ivar configuration value napoleon_use_keyword configuration value napoleon_use_param configuration value napoleon_use_rtype configuration value needs_extensions configuration value needs_sphinx configuration value nested_parse_to_nodes() (in module sphinx.util.parsing) new_serialno() (sphinx.environment.BuildEnvironment method) newest_template_mtime() (sphinx.application.TemplateBridge method) newsgroup (role) next (built-in variable) nitpick_ignore configuration value nitpick_ignore_regex configuration value nitpicky configuration value note admonition note (directive) note_dependency() (sphinx.environment.BuildEnvironment method) note_module() (sphinx.domains.python.PythonDomain method) note_object() (sphinx.domains.python.PythonDomain method) note_reread() (sphinx.environment.BuildEnvironment method) numfig configuration value numfig_format configuration value numfig_secnum_depth configuration value numref (role)

O

:options: (directive option) doctest (directive) testoutput (directive) object (directive) object-description-transform event object_types (sphinx.domains.Domain attribute) ObjectDescription (class in sphinx.directives) objects (sphinx.domains.python.PythonDomain attribute) objname (built-in variable) objtype (built-in variable) ObjType (class in sphinx.domains)

only (class in sphinx.addnodes) (directive) option (directive) (role) option_emphasise_placeholders configuration value option_spec (docutils.parsers.rst.Directive attribute) (sphinx.directives.ObjectDescription attribute) optional_arguments (docutils.parsers.rst.Directive attribute) (sphinx.directives.ObjectDescription attribute) options (docutils.parsers.rst.Directive attribute) (sphinx.util.docutils.SphinxRole attribute) out_suffix (sphinxcontrib.serializinghtml.SerializingHTMLBuilder attribute) outdir (sphinx.application.Sphinx attribute)

P

:platform: (directive option) automodule (directive) py:module (directive) :prepend: (directive option) literalinclude (directive) :private-members: (directive option) autoclass (directive) automodule (directive) :pyobject: (directive option) literalinclude (directive) :pyversion: (directive option) doctest (directive) page_source_suffix (built-in variable) pagename (built-in variable) parallel_read_safe (sphinx.util.typing.ExtensionMetadata attribute) parallel_write_safe (sphinx.util.typing.ExtensionMetadata attribute) parents (built-in variable) parse_content_to_nodes() (sphinx.util.docutils.SphinxDirective method) parse_inline() (sphinx.util.docutils.SphinxDirective method) parse_text_to_nodes() (sphinx.util.docutils.SphinxDirective method) Parser (class in sphinx.parsers) parser (sphinx.environment.BuildEnvironment attribute) path2doc() (sphinx.project.Project method) pathto() built-in function pending_logging() (in module sphinx.util.logging) pending_warnings() (in module sphinx.util.logging) pending_xref (class in sphinx.addnodes) pending_xref_condition (class in sphinx.addnodes) pep (role) PickleHTMLBuilder (class in sphinxcontrib.serializinghtml) post_build() (sphinxcontrib.websupport.storage.StorageBackend method) pre_build() (sphinxcontrib.websupport.storage.StorageBackend method) prefixed_warnings() (in module sphinx.util.logging) prepare_writing() (sphinx.builders.Builder method) prev (built-in variable) primary_domain configuration value process_doc() (sphinx.domains.Domain method) (sphinx.environment.collectors.EnvironmentCollector method) process_field_xref() (sphinx.domains.Domain method) process_vote() (sphinxcontrib.websupport.storage.StorageBackend method) (sphinxcontrib.websupport.WebSupport method) production (class in sphinx.addnodes) productionlist (class in sphinx.addnodes) (directive) program (directive) (role) project configuration value project (built-in variable) Project (class in sphinx.project) project (sphinx.application.Sphinx attribute) (sphinx.environment.BuildEnvironment attribute) project_copyright configuration value PseudoXMLBuilder (class in sphinx.builders.xml) py:attr (role) py:attribute (directive) :canonical: (directive option) :type: (directive option) :value: (directive option) py:class (directive) :abstract: (directive option) :canonical: (directive option) :final: (directive option) :single-line-parameter-list: (directive option) :single-line-type-parameter-list: (directive option) py:class (role) py:classmethod (directive) py:const (role) py:currentmodule (directive) py:data (directive) :canonical: (directive option) :type: (directive option) :value: (directive option)

py:data (role) py:deco (role) py:decorator (directive) :single-line-parameter-list: (directive option) :single-line-type-parameter-list: (directive option) py:decoratormethod (directive) py:exc (role) py:exception (directive) :final: (directive option) :single-line-parameter-list: (directive option) :single-line-type-parameter-list: (directive option) py:func (role) py:function (directive) :async: (directive option) :canonical: (directive option) :single-line-parameter-list: (directive option) :single-line-type-parameter-list: (directive option) py:meth (role) py:method (directive) :abstract: (directive option) :abstractmethod: (directive option) :async: (directive option) :canonical: (directive option) :classmethod: (directive option) :final: (directive option) :single-line-parameter-list: (directive option) :single-line-type-parameter-list: (directive option) :staticmethod: (directive option) py:mod (role) py:module (directive) :deprecated: (directive option) :platform: (directive option) :synopsis: (directive option) py:obj (role) py:property (directive) :abstract: (directive option) :abstractmethod: (directive option) :classmethod: (directive option) :type: (directive option) py:staticmethod (directive) py:type (directive) :canonical: (directive option) py:type (role) pygments_style configuration value Python Enhancement Proposals PEP 257#what-is-a-docstring PEP 287 PEP 420, [1], [2] PEP 440 PEP 440#version-specifiers PEP 484, [1], [2] PEP 526, [1] PEP 563 PEP 585 PEP 604 PEP 695, [1], [2], [3], [4], [5] PEP 696 PEP 8 python:PYTHONWARNINGS python_display_short_literal_types configuration value python_maximum_signature_line_length configuration value python_trailing_comma_in_multi_line_signatures configuration value python_use_unqualified_type_names configuration value PythonDomain (class in sphinx.domains.python) PyType_GenericAlloc (C function)

Q

qthelp_basename configuration value qthelp_namespace configuration value qthelp_theme configuration value

qthelp_theme_options configuration value QtHelpBuilder (class in sphinxcontrib.qthelp) qualifier (sphinx.domains.IndexEntry attribute) query() (sphinxcontrib.websupport.search.BaseSearch method)

R

:recursive: (directive option) autosummary (directive) :reversed: (directive option) toctree (directive) rawtext (sphinx.util.docutils.SphinxRole attribute) read() (sphinx.builders.Builder method) read_doc() (sphinx.builders.Builder method) ref (role) ReferenceRole (class in sphinx.util.docutils) regexp (role) relbar() built-in function reldelim1 (built-in variable) reldelim2 (built-in variable) release configuration value release (built-in variable) relfn2path() (sphinx.environment.BuildEnvironment method) rellinks (built-in variable) removed in version RemoveInSphinxXXXWarning render() (sphinx.application.TemplateBridge method) render_string() (sphinx.application.TemplateBridge method) require_sphinx() (sphinx.application.Sphinx static method) required_arguments (docutils.parsers.rst.Directive attribute) (sphinx.directives.ObjectDescription attribute) resolve_any_xref() (sphinx.domains.Domain method) resolve_xref() (sphinx.domains.Domain method) restore() (sphinx.project.Project method)

reStructuredText RFC RFC 2324 RFC 3986 Section 4.4, [1] RFC 6596 RFC 8081 rfc (role) role role() (sphinx.domains.Domain method) roles (sphinx.domains.Domain attribute) root document root_doc configuration value root_doc (built-in variable) rst:dir (role) rst:directive (directive) rst:directive:option (directive) :type: (directive option) rst:role (directive) (role) rst_epilog configuration value rst_prolog configuration value rubric (directive) :class: (directive option) :heading-level: (directive option) :name: (directive option) run() (docutils.parsers.rst.Directive method) (sphinx.directives.ObjectDescription method) (sphinx.transforms.post_transforms.SphinxPostTransform method)

S

:show-inheritance: (directive option) autoclass (directive) automodule (directive) :signatures: (directive option) autosummary (directive) :single-line-parameter-list: (directive option) c:function (directive) c:macro (directive) cpp:function (directive) js:class (directive) js:function (directive) js:method (directive) py:class (directive) py:decorator (directive) py:exception (directive) py:function (directive) py:method (directive) :single-line-type-parameter-list: (directive option) py:class (directive) py:decorator (directive) py:exception (directive) py:function (directive) py:method (directive) :skipif: (directive option) doctest (directive) testcleanup (directive) testcode (directive) testoutput (directive) testsetup (directive) :sorted: (directive option) glossary (directive) :special-members: (directive option) autoclass (directive) automodule (directive) :start-after: (directive option) literalinclude (directive) :start-at: (directive option) literalinclude (directive) :staticmethod: (directive option) py:method (directive) :synopsis: (directive option) automodule (directive) py:module (directive) samp (role) script_files (built-in variable) search toctree searchindex_filename (sphinxcontrib.serializinghtml.SerializingHTMLBuilder attribute) sectionauthor (directive) seealso (class in sphinx.addnodes) (directive) SerializingHTMLBuilder (class in sphinxcontrib.serializinghtml) set_application() (sphinx.parsers.Parser method) set_html_assets_policy() (sphinx.application.Sphinx method) set_source_info() (sphinx.util.docutils.SphinxDirective method) set_translator() (sphinx.application.Sphinx method) setup() (sphinx.domains.Domain method) setup_extension() (sphinx.application.Sphinx method) shorttitle (built-in variable) show_authors configuration value show_source (built-in variable) show_warning_types configuration value sidebar() built-in function SIG_ELEMENTS (in module sphinx.addnodes) SingleFileHTMLBuilder (class in sphinx.builders.singlehtml) singlehtml_sidebars configuration value smartquotes configuration value smartquotes_action configuration value smartquotes_excludes configuration value snippets testing source directory source-read event source_encoding configuration value source_suffix configuration value source_suffix (sphinx.project.Project attribute) sourcecode (directive) sourcename (built-in variable) Sphinx (class in sphinx.application) sphinx-apidoc command line option --dry-run --follow-links --force --full --implicit-namespaces --module-first --no-headings --no-toc --private --remove-old --separate --templatedir --tocfile -a -A -d -e -E -f -F -H -l -M -n -o -P -q -R -s -T -t -V sphinx-autogen command line option --imported-members --remove-old --respect-module-all --suffix --templates -a -i -o -s -t sphinx-build command line option --builder --color --conf-dir --define --doctree-dir --exception-on-warning --fail-on-warning --fresh-env --help --html-define --isolated --jobs --keep-going --nitpicky --no-color --pdb --quiet --show-traceback --silent --tag --verbose --version --warning-file --write-all -a -A -b -c -C -d -D -E -h -j -M -n -N -P -q -Q -t -T -v -w -W sphinx-quickstart command line option --author --batchfile --dot --ext-autodoc --ext-coverage --ext-doctest --ext-githubpages --ext-ifconfig --ext-imgmath --ext-intersphinx --ext-mathjax --ext-todo --ext-viewcode --extensions --help --language --makefile --master --no-batchfile --no-makefile --no-sep --no-use-make-mode --project --quiet --release --sep --suffix --templatedir --use-make-mode --version -a -d -h -l -p -q -r -t -v

sphinx.addnodes module sphinx.application module sphinx.builders module sphinx.builders.changes module sphinx.builders.dirhtml module sphinx.builders.dummy module sphinx.builders.epub3 module sphinx.builders.gettext module sphinx.builders.html module sphinx.builders.latex module sphinx.builders.linkcheck module sphinx.builders.manpage module sphinx.builders.singlehtml module sphinx.builders.texinfo module sphinx.builders.text module sphinx.builders.xml module sphinx.directives module sphinx.domains module sphinx.domains.python module sphinx.environment module sphinx.environment.collectors module sphinx.errors module sphinx.ext.apidoc module sphinx.ext.autodoc module sphinx.ext.autosectionlabel module sphinx.ext.autosummary module sphinx.ext.coverage module sphinx.ext.doctest module sphinx.ext.duration module sphinx.ext.extlinks module sphinx.ext.githubpages module sphinx.ext.graphviz module sphinx.ext.ifconfig module sphinx.ext.imgconverter module sphinx.ext.imgmath module sphinx.ext.inheritance_diagram module sphinx.ext.intersphinx module sphinx.ext.jsmath module sphinx.ext.linkcode module sphinx.ext.mathbase module sphinx.ext.mathjax module sphinx.ext.napoleon module sphinx.ext.todo module sphinx.ext.viewcode module sphinx.parsers module sphinx.testing module sphinx_version (built-in variable) sphinx_version_tuple (built-in variable) sphinxcontrib.applehelp module sphinxcontrib.devhelp module sphinxcontrib.htmlhelp module sphinxcontrib.qthelp module SphinxDirective (class in sphinx.util.docutils) SphinxError SphinxLoggerAdapter (class in sphinx.util.logging) SphinxPostTransform (class in sphinx.transforms.post_transforms) SphinxRole (class in sphinx.util.docutils) SphinxTransform (class in sphinx.transforms) srcdir (sphinx.application.Sphinx attribute) (sphinx.environment.BuildEnvironment attribute) (sphinx.project.Project attribute) StandaloneHTMLBuilder (class in sphinx.builders.html) start_of_file (class in sphinx.addnodes) state (docutils.parsers.rst.Directive attribute) state_machine (docutils.parsers.rst.Directive attribute) StorageBackend (class in sphinxcontrib.websupport.storage) strip_signature_backslash configuration value styles (built-in variable) substitutions global, [1], [2] subtype (sphinx.domains.IndexEntry attribute) supported_data_uri_images (sphinx.builders.Builder attribute) supported_image_types (sphinx.builders.Builder attribute) (sphinx.builders.changes.ChangesBuilder attribute) (sphinx.builders.dirhtml.DirectoryHTMLBuilder attribute) (sphinx.builders.dummy.DummyBuilder attribute) (sphinx.builders.epub3.Epub3Builder attribute) (sphinx.builders.gettext.MessageCatalogBuilder attribute) (sphinx.builders.html.StandaloneHTMLBuilder attribute) (sphinx.builders.latex.LaTeXBuilder attribute) (sphinx.builders.linkcheck.CheckExternalLinksBuilder attribute) (sphinx.builders.manpage.ManualPageBuilder attribute) (sphinx.builders.singlehtml.SingleFileHTMLBuilder attribute) (sphinx.builders.texinfo.TexinfoBuilder attribute) (sphinx.builders.text.TextBuilder attribute) (sphinx.builders.xml.PseudoXMLBuilder attribute) (sphinx.builders.xml.XMLBuilder attribute) (sphinxcontrib.applehelp.AppleHelpBuilder attribute) (sphinxcontrib.devhelp.DevhelpBuilder attribute) (sphinxcontrib.htmlhelp.HTMLHelpBuilder attribute) (sphinxcontrib.qthelp.QtHelpBuilder attribute) (sphinxcontrib.serializinghtml.JSONHTMLBuilder attribute) (sphinxcontrib.serializinghtml.PickleHTMLBuilder attribute) supported_linkcode (sphinx.builders.Builder attribute) supported_remote_images (sphinx.builders.Builder attribute) suppress_warnings configuration value

T

:tab-width: (directive option) literalinclude (directive) :template: (directive option) autosummary (directive) :titlesonly: (directive option) toctree (directive) :toctree: (directive option) autosummary (directive) :trim-doctest-flags: (directive option) doctest (directive) testcode (directive) testoutput (directive) :type: (directive option) confval (directive) py:attribute (directive) py:data (directive) py:property (directive) rst:directive:option (directive) table of contents tabularcolumns (directive) target (sphinx.util.docutils.ReferenceRole attribute) template_bridge configuration value TemplateBridge (class in sphinx.application) templates_path configuration value term (role) testcleanup (directive) :skipif: (directive option) testcode (directive) :hide: (directive option) :no-trim-doctest-flags: (directive option) :skipif: (directive option) :trim-doctest-flags: (directive option) testing automatic snippets testoutput (directive) :hide: (directive option) :no-trim-doctest-flags: (directive option) :options: (directive option) :skipif: (directive option) :trim-doctest-flags: (directive option) testsetup (directive) :skipif: (directive option) texinfo_appendices configuration value texinfo_cross_references configuration value texinfo_documents configuration value texinfo_domain_indices configuration value texinfo_elements configuration value texinfo_no_detailmenu configuration value texinfo_show_urls configuration value TexinfoBuilder (class in sphinx.builders.texinfo) text (sphinx.util.docutils.SphinxRole attribute) text_add_secnumbers configuration value

text_newlines configuration value text_secnumber_suffix configuration value text_sectionchars configuration value TextBuilder (class in sphinx.builders.text) the_answer configuration value ThemeError tip admonition tip (directive) title (built-in variable) (sphinx.util.docutils.ReferenceRole attribute) titles (sphinx.environment.BuildEnvironment attribute) tls_cacerts configuration value tls_verify configuration value toc (built-in variable) toc_object_entries configuration value toc_object_entries_show_parents configuration value toctree genindex modindex search toctree (built-in variable) (class in sphinx.addnodes) toctree (directive) :caption: (directive option) :class: (directive option) :glob: (directive option) :hidden: (directive option) :includehidden: (directive option) :name: (directive option) :numbered: (directive option) :reversed: (directive option) :titlesonly: (directive option) today configuration value today_fmt configuration value todo (directive) todo-defined event todo_emit_warnings configuration value todo_include_todos configuration value todo_link_only configuration value todolist (directive) token (role) transform_content() (sphinx.directives.ObjectDescription method) translation_progress_classes configuration value trim_doctest_flags configuration value trim_footnote_reference_space configuration value

U

:undoc-members: (directive option) autoclass (directive) automodule (directive) underline (built-in variable)

update_username() (sphinxcontrib.websupport.storage.StorageBackend method) use_opensearch (built-in variable) user_agent configuration value

V

:value: (directive option) py:attribute (directive) py:data (directive) verbose() (sphinx.util.logging.SphinxLoggerAdapter method) version configuration value version (built-in variable) (sphinx.util.typing.ExtensionMetadata attribute) version_info (in module sphinx) versionadded (directive) versionchanged (directive) versionmodified (class in sphinx.addnodes)

versionremoved (directive) VersionRequirementError viewcode-find-source event viewcode-follow-imported event viewcode_enable_epub configuration value viewcode_follow_imported_members configuration value viewcode_line_numbers configuration value

W

warn-missing-reference event warning admonition warning (directive) warning() built-in function

warning() (sphinx.util.logging.SphinxLoggerAdapter method) WebSupport (class in sphinxcontrib.websupport) write() (sphinx.builders.Builder method) write-started event write_doc() (sphinx.builders.Builder method) write_doctree() (sphinx.builders.Builder method) write_documents() (sphinx.builders.Builder method)

X

xml_pretty configuration value

XMLBuilder (class in sphinx.builders.xml)