sphinx context¶

These are all the values from the Sphinx config object:

add_function_parentheses:

True

add_module_names:

True

applehelp_bundle_id:

None

applehelp_bundle_version:

'1'

applehelp_codesign_path:

'/usr/bin/codesign'

applehelp_dev_region:

'en-us'

applehelp_disable_external_tools:

False

applehelp_icon:

None

applehelp_index_anchors:

False

applehelp_indexer_path:

'/usr/bin/hiutil'

applehelp_kb_url:

None

applehelp_min_term_length:

None

applehelp_remote_url:

None

author:

'Author name not set'

autorun_languages:

      {'console': 'bash',
'console_prefix_chars': 1,
'pycon': 'python '
         '/home/docs/checkouts/readthedocs.org/user_builds/test-builds/envs/immaterial-theme/lib/python3.12/site-packages/sphinx_autorun/pycon.py',
'pycon_prefix_chars': 4,
'pycon_show_source': False}

c_extra_keywords:

      ['alignas',
'alignof',
'bool',
'complex',
'imaginary',
'noreturn',
'static_assert',
'thread_local']

c_id_attributes:

[]

c_maximum_signature_line_length:

None

c_paren_attributes:

[]

clickable_checkbox:

False

cpp_debug_lookup:

False

cpp_debug_show_tree:

False

cpp_id_attributes:

[]

cpp_index_common_prefix:

[]

cpp_maximum_signature_line_length:

None

cpp_paren_attributes:

[]

cpp_strip_namespaces_from_signatures:

[]

cpp_xref_resolve_c_macro_pattern:

'[A-Z]+[A-Z_0-9]*'

custom_checkbox:

False

default_role:

None

epub_contributor:

'unknown'

epub_cover:

()

epub_css_files:

[]

epub_description:

'unknown'

epub_exclude_files:

[]

epub_fix_images:

False

epub_guide:

()

epub_identifier:

'unknown'

epub_max_image_width:

0

epub_post_files:

[]

epub_pre_files:

[]

epub_scheme:

'unknown'

epub_show_urls:

'inline'

epub_theme:

'epub'

epub_theme_options:

{}

epub_tocdepth:

3

epub_tocdup:

True

epub_tocscope:

'default'

epub_uid:

'unknown'

epub_version:

3.0

epub_writing_mode:

'horizontal'

exclude_patterns:

['_build']

extensions:

      ['readthedocs_ext.readthedocs',
'sphinx_autorun',
'notfound.extension',
'hoverxref.extension',
'sphinx_js',
'sphinx_tabs.tabs',
'sphinx_jinja2',
'sphinx_immaterial']

figure_language_filename:

'{root}.{language}{ext}'

gettext_additional_targets:

[]

gettext_allow_fuzzy_translations:

False

gettext_auto_build:

True

gettext_compact:

True

gettext_language_team:

'LANGUAGE <LL@li.org>'

gettext_last_translator:

'FULL NAME <EMAIL@ADDRESS>'

gettext_location:

True

gettext_uuid:

False

highlight_language:

'default'

highlight_options:

{}

hoverxref_api_host:

'/_'

hoverxref_auto_ref:

True

hoverxref_default_type:

'tooltip'

hoverxref_domains:

[]

hoverxref_ignore_refs:

['genindex', 'modindex', 'search']

hoverxref_intersphinx:

[]

hoverxref_intersphinx_types:

{}

hoverxref_mathjax:

False

hoverxref_modal_awaitcloseanimation:

False

hoverxref_modal_awaitopenanimation:

False

hoverxref_modal_class:

'rst-content'

hoverxref_modal_debugmode:

False

hoverxref_modal_default_title:

'Note'

hoverxref_modal_disable_focus:

True

hoverxref_modal_disable_scroll:

False

hoverxref_modal_hover_delay:

350

hoverxref_modal_onshow_function:

None

hoverxref_modal_openclass:

'is-open'

hoverxref_modal_prefix_title:

'📝 '

hoverxref_role_types:

{}

hoverxref_roles:

['term']

hoverxref_sphinx_version:

'7.4.4'

hoverxref_sphinxtabs:

False

hoverxref_tooltip_animation:

'fade'

hoverxref_tooltip_animation_duration:

0

hoverxref_tooltip_api_host:

'/_'

hoverxref_tooltip_class:

'rst-content'

hoverxref_tooltip_content:

'Loading...'

hoverxref_tooltip_interactive:

True

hoverxref_tooltip_lazy:

False

hoverxref_tooltip_maxwidth:

450

hoverxref_tooltip_side:

'right'

hoverxref_tooltip_theme:

['tooltipster-shadow', 'tooltipster-shadow-custom']

html4_writer:

False

html_additional_pages:

{}

html_baseurl:

''

html_codeblock_linenos_style:

'table'

html_compact_lists:

True

html_context:

      {'MEDIA_URL': 'https://media.readthedocs.org/',
'PRODUCTION_DOMAIN': 'readthedocs.org',
'READTHEDOCS': True,
'STATIC_URL': 'https://assets.readthedocs.org/static/',
'ad_free': False,
'analytics_code': 'UA-12341234-1',
'api_host': 'https://readthedocs.org',
'bitbucket_repo': 'None',
'bitbucket_user': 'None',
'bitbucket_version': 'immaterial-theme',
'canonical_url': None,
'comment': 'This comment is injected manually as a test.',
'commit': '18457f1d',
'conf_py_path': '/docs/',
'current_version': 'immaterial-theme',
'display_bitbucket': False,
'display_github': True,
'display_gitlab': False,
'docsearch_disabled': False,
'downloads': [],
'github_repo': 'test-builds',
'github_user': 'readthedocs',
'github_version': 'immaterial-theme',
'gitlab_repo': 'None',
'gitlab_user': 'None',
'gitlab_version': 'immaterial-theme',
'global_analytics_code': None,
'html_theme': 'sphinx_immaterial',
'name': 'test-builds',
'new_theme': False,
'programming_language': 'words',
'proxied_api_host': '/_',
'proxied_static_path': '/_/static/',
'rtd_language': 'en',
'single_version': False,
'slug': 'test-builds',
'source_suffix': '.rst',
'subprojects': [],
'user_analytics_code': 'UA-12341234-1',
'using_theme': False,
'version_slug': 'immaterial-theme',
'versions': [('latest', '/en/latest/'),
             ('2.0', '/en/2.0/'),
             ('yaml-v2', '/en/yaml-v2/'),
             ('wormhole', '/en/wormhole/'),
             ('vitepress', '/en/vitepress/'),
             ('use-requirements-from-submodule',
              '/en/use-requirements-from-submodule/'),
             ('use-py2', '/en/use-py2/'),
             ('use-apt', '/en/use-apt/'),
             ('update-conda-startup', '/en/update-conda-startup/'),
             ('unicode-paths', '/en/unicode-paths/'),
             ('unicode-filename', '/en/unicode-filename/'),
             ('d--branch', '/en/d--branch/'),
             ('ubuntu-22.04-python3.x', '/en/ubuntu-22.04-python3.x/'),
             ('ubuntu-22.04-python3.6', '/en/ubuntu-22.04-python3.6/'),
             ('ubuntu-22.04-python3.12', '/en/ubuntu-22.04-python3.12/'),
             ('ubuntu-22.04-python2.7', '/en/ubuntu-22.04-python2.7/'),
             ('ubuntu-22.04', '/en/ubuntu-22.04/'),
             ('ubuntu-20.04-python-3.9', '/en/ubuntu-20.04-python-3.9/'),
             ('ubuntu-20.04', '/en/ubuntu-20.04/'),
             ('typlog-theme', '/en/typlog-theme/'),
             ('timetest', '/en/timetest/'),
             ('timeout', '/en/timeout/'),
             ('throw-exception', '/en/throw-exception/'),
             ('test-ubuntu-20.04', '/en/test-ubuntu-20.04/'),
             ('test-paths-with-spaces', '/en/test-paths-with-spaces/'),
             ('test-parent-path-error', '/en/test-parent-path-error/'),
             ('test-auto-cancel', '/en/test-auto-cancel/'),
             ('template-config-file', '/en/template-config-file/'),
             ('sudo-commands', '/en/sudo-commands/'),
             ('submodule-not-found', '/en/submodule-not-found/'),
             ('submodule-https-scheme', '/en/submodule-https-scheme/'),
             ('submodule-git-scheme', '/en/submodule-git-scheme/'),
             ('staticrypt', '/en/staticrypt/'),
             ('sphinx-tectonic-pdf', '/en/sphinx-tectonic-pdf/'),
             ('sphinx-multipage-html', '/en/sphinx-multipage-html/'),
             ('sphinx-mkdocstrings', '/en/sphinx-mkdocstrings/'),
             ('sphinx-latest', '/en/sphinx-latest/'),
             ('sphinx-hoverxref', '/en/sphinx-hoverxref/'),
             ('sphinx.ext.duration', '/en/sphinx.ext.duration/'),
             ('sphinx-docs-zundler', '/en/sphinx-docs-zundler/'),
             ('sphinx-conf-nonstandard', '/en/sphinx-conf-nonstandard/'),
             ('sphinx-awesome', '/en/sphinx-awesome/'),
             ('sphinx-7.0.x', '/en/sphinx-7.0.x/'),
             ('sphinx6.x-default', '/en/sphinx6.x-default/'),
             ('sphinx-1.8', '/en/sphinx-1.8/'),
             ('skip-build-command-pr-test3',
              '/en/skip-build-command-pr-test3/'),
             ('skip-build-command-pr-test2',
              '/en/skip-build-command-pr-test2/'),
             ('skip-build-command', '/en/skip-build-command/'),
             ('singlehtml', '/en/singlehtml/'),
             ('search-special-chars', '/en/search-special-chars/'),
             ('rust-1.75', '/en/rust-1.75/'),
             ('rust', '/en/rust/'),
             ('robots-txt', '/en/robots-txt/'),
             ('requirements-not-found', '/en/requirements-not-found/'),
             ('readthedocs-docs-build-commands',
              '/en/readthedocs-docs-build-commands/'),
             ('python-system-packages', '/en/python-system-packages/'),
             ('python-setuptools-package', '/en/python-setuptools-package/'),
             ('pypy3.5', '/en/pypy3.5/'),
             ('pydata-theme', '/en/pydata-theme/'),
             ('py3.9', '/en/py3.9/'),
             ('pr-visual-diff', '/en/pr-visual-diff/'),
             ('pr-test-git-clone-test', '/en/pr-test-git-clone-test/'),
             ('pr-test', '/en/pr-test/'),
             ('pr-readthedocs_output', '/en/pr-readthedocs_output/'),
             ('pr-js-client', '/en/pr-js-client/'),
             ('pr-homepage-edition', '/en/pr-homepage-edition/'),
             ('pr-docusaurus', '/en/pr-docusaurus/'),
             ('poetry-asdf', '/en/poetry-asdf/'),
             ('poetry', '/en/poetry/'),
             ('pelican', '/en/pelican/'),
             ('pdoc', '/en/pdoc/'),
             ('pdf-rinohtype', '/en/pdf-rinohtype/'),
             ('pdf-cmd-fail', '/en/pdf-cmd-fail/'),
             ('pdf-build-jobs', '/en/pdf-build-jobs/'),
             ('old-output-directory', '/en/old-output-directory/'),
             ('no-pr-build', '/en/no-pr-build/'),
             ('no-html-theme-defined', '/en/no-html-theme-defined/'),
             ('no-conf-py', '/en/no-conf-py/'),
             ('no-config-file', '/en/no-config-file/'),
             ('multiple-source-suffix', '/en/multiple-source-suffix/'),
             ('monorepo', '/en/monorepo/'),
             ('mkdocs-terminal', '/en/mkdocs-terminal/'),
             ('mkdocs-python-tags', '/en/mkdocs-python-tags/'),
             ('mkdocs-pdf', '/en/mkdocs-pdf/'),
             ('mkdocs-material', '/en/mkdocs-material/'),
             ('mkdocs-htmlzip', '/en/mkdocs-htmlzip/'),
             ('mkdocs-config-at-root', '/en/mkdocs-config-at-root/'),
             ('mkdocs', '/en/mkdocs/'),
             ('mamba', '/en/mamba/'),
             ('latest-aliases', '/en/latest-aliases/'),
             ('jupyter-book', '/en/jupyter-book/'),
             ('jsdoc-autoapi', '/en/jsdoc-autoapi/'),
             ('jsdoc', '/en/jsdoc/'),
             ('jekyll', '/en/jekyll/'),
             ('japanese-pdf', '/en/japanese-pdf/'),
             ('invalid-submodules', '/en/invalid-submodules/'),
             ('invalid-docker-image', '/en/invalid-docker-image/'),
             ('install-setuptools', '/en/install-setuptools/'),
             ('insipid-theme', '/en/insipid-theme/'),
             ('immaterial-theme', '/en/immaterial-theme/'),
             ('htmldir', '/en/htmldir/'),
             ('git-submodules-invalid', '/en/git-submodules-invalid/'),
             ('git-submodules', '/en/git-submodules/'),
             ('git-lfs-build-jobs', '/en/git-lfs-build-jobs/'),
             ('furo', '/en/furo/'),
             ('foo', '/en/foo/'),
             ('expose-env-pip-error', '/en/expose-env-pip-error/'),
             ('envvar-config-file', '/en/envvar-config-file/'),
             ('environment-variables', '/en/environment-variables/'),
             ('docusaurus', '/en/docusaurus/'),
             ('docsify', '/en/docsify/'),
             ('disable-sphinx-manipulation',
              '/en/disable-sphinx-manipulation/'),
             ('d2lbook', '/en/d2lbook/'),
             ('config-file-with-wrong-version-number',
              '/en/config-file-with-wrong-version-number/'),
             ('conda-pin-common-deps', '/en/conda-pin-common-deps/'),
             ('conda-env-py3.7', '/en/conda-env-py3.7/'),
             ('conda-env-no-py-pinned', '/en/conda-env-no-py-pinned/'),
             ('conda-env', '/en/conda-env/'),
             ('conda-build-commands', '/en/conda-build-commands/'),
             ('c-dependencies', '/en/c-dependencies/'),
             ('build-tools-mamba', '/en/build-tools-mamba/'),
             ('build-tools-golang-invalid', '/en/build-tools-golang-invalid/'),
             ('build-tools-conda', '/en/build-tools-conda/'),
             ('build-tools', '/en/build-tools/'),
             ('build-os-error-message', '/en/build-os-error-message/'),
             ('build-latest-python-3.8', '/en/build-latest-python-3.8/'),
             ('build-jobs-spaces-in-command',
              '/en/build-jobs-spaces-in-command/'),
             ('build-jobs-post-build', '/en/build-jobs-post-build/'),
             ('build-jobs-multiline', '/en/build-jobs-multiline/'),
             ('build-jobs-diff-exit', '/en/build-jobs-diff-exit/'),
             ('build-jobs', '/en/build-jobs/'),
             ('build-internals', '/en/build-internals/'),
             ('build-commands-multiline', '/en/build-commands-multiline/'),
             ('build-commands-env-vars', '/en/build-commands-env-vars/'),
             ('build-commands', '/en/build-commands/'),
             ('branch-with-slashes', '/en/branch-with-slashes/'),
             ('bare-commands', '/en/bare-commands/'),
             ('asciidoctor', '/en/asciidoctor/'),
             ('antora', '/en/antora/'),
             ('annotated-tag', '/en/annotated-tag/'),
             ('all-formats-build-jobs', '/en/all-formats-build-jobs/'),
             ('all-formats-build-commands', '/en/all-formats-build-commands/'),
             ('all-formats', '/en/all-formats/'),
             ('alabaster-theme', '/en/alabaster-theme/')]}

html_copy_source:

True

html_css_files:

[]

html_domain_indices:

True

html_extra_path:

['static']

html_favicon:

None

html_file_suffix:

None

html_js_files:

[]

html_last_updated_fmt:

None

html_link_suffix:

None

html_logo:

None

html_math_renderer:

None

html_output_encoding:

'utf-8'

html_permalinks:

True

html_permalinks_icon:

'¶'

html_scaled_image_link:

True

html_search_language:

None

html_search_options:

{}

html_search_scorer:

''

html_secnumber_suffix:

'. '

html_show_copyright:

True

html_show_search_summary:

True

html_show_sourcelink:

True

html_show_sphinx:

True

html_sidebars:

{}

html_sourcelink_suffix:

'.txt'

html_split_index:

False

html_static_path:

['/home/docs/checkouts/readthedocs.org/user_builds/test-builds/envs/immaterial-theme/lib/python3.12/site-packages/sphinx_tabs/static']

html_style:

None

html_theme:

'sphinx_immaterial'

html_theme_options:

      {'edit_uri': '',
'features': [],
'font': {'code': 'Roboto Mono', 'text': 'Roboto'},
'globaltoc_collapse': True,
'icon': {},
'plugins': {'search': {}},
'repo_url': '',
'toc_title': None,
'toc_title_is_page_title': False}

html_theme_path:

[]

html_use_directory_uris_for_index_pages:

False

html_use_index:

True

html_use_opensearch:

''

htmlhelp_file_suffix:

None

htmlhelp_link_suffix:

None

include_patterns:

['**']

javascript_maximum_signature_line_length:

None

jinja2_contexts:

{}

jinja2_debug:

False

jinja2_env_kwargs:

{'extensions': ['jinja2.ext.loopcontrols']}

jinja2_filters:

{}

jinja2_tests:

{}

jquery_use_sri:

False

js_language:

'javascript'

js_source_path:

'../src/'

jsdoc_config_path:

None

keep_warnings:

False

language:

'en'

latex_additional_files:

[]

latex_appendices:

[]

latex_domain_indices:

True

latex_elements:

{}

latex_engine:

'xelatex'

latex_logo:

None

latex_show_pagerefs:

False

latex_show_urls:

'no'

latex_table_style:

['booktabs', 'colorrows']

latex_theme:

'manual'

latex_theme_options:

{}

latex_theme_path:

[]

latex_toplevel_sectioning:

None

latex_use_latex_multicolumn:

False

latex_use_xindy:

False

linkcheck_allow_unauthorized:

True

linkcheck_allowed_redirects:

{}

linkcheck_anchors:

True

linkcheck_anchors_ignore:

['^!']

linkcheck_anchors_ignore_for_url:

()

linkcheck_auth:

[]

linkcheck_exclude_documents:

[]

linkcheck_ignore:

[]

linkcheck_rate_limit_timeout:

300.0

linkcheck_report_timeouts_as_broken:

True

linkcheck_request_headers:

{}

linkcheck_retries:

1

linkcheck_timeout:

30

linkcheck_workers:

5

locale_dirs:

['locales']

man_make_section_directory:

False

man_show_urls:

False

manpages_url:

None

master_doc:

'index'

math_eqref_format:

None

math_number_all:

False

math_numfig:

True

math_numsep:

'.'

mathjax3_config:

None

mathjax_config:

None

mathjax_display:

['\\[', '\\]']

mathjax_inline:

['\\(', '\\)']

mathjax_options:

{'async': None, 'id': 'MathJax-script'}

mathjax_path:

'mathjax/tex-mml-chtml.js'

maximum_signature_line_length:

None

modindex_common_prefix:

[]

needs_extensions:

{}

needs_sphinx:

None

nitpick_ignore:

[]

nitpick_ignore_regex:

[]

nitpicky:

False

notfound_context:

      {'body': '<h1>Page not found</h1>\n'
        '\n'
        "Unfortunately we couldn't find the content you were looking for.",
'title': 'Page not found'}

notfound_pagename:

'404'

notfound_template:

'page.html'

notfound_urls_prefix:

'/en/immaterial-theme/'

numfig:

False

numfig_format:

      {'code-block': 'Listing %s',
'figure': 'Fig. %s',
'section': 'Section %s',
'table': 'Table %s'}

numfig_secnum_depth:

1

object_description_options:

[]

option_emphasise_placeholders:

False

primary_domain:

'py'

project:

'Test Builds'

project_copyright:

''

pygments_style:

None

python_display_short_literal_types:

False

python_maximum_signature_line_length:

None

python_module_names_to_strip_from_xrefs:

[]

python_resolve_unqualified_typing:

True

python_strip_property_prefix:

False

python_strip_return_type_annotations:

re.compile('.*.(__setitem__|__init__)')

python_strip_self_type_annotations:

True

python_transform_type_annotations_concise_literal:

True

python_transform_type_annotations_pep585:

True

python_transform_type_annotations_pep604:

True

python_transform_typing_extensions:

True

python_type_aliases:

{}

python_use_unqualified_type_names:

False

qthelp_namespace:

None

qthelp_theme:

'nonav'

qthelp_theme_options:

{}

readthedocs_embed_doc:

''

readthedocs_embed_project:

''

readthedocs_embed_version:

''

release:

''

root_for_relative_js_paths:

None

rst_epilog:

None

rst_prolog:

None

rtd_generate_json_artifacts:

False

setup:

None

show_authors:

False

show_warning_types:

False

smartquotes:

True

smartquotes_action:

'qDe'

smartquotes_excludes:

{'builders': ['man', 'text'], 'languages': ['ja']}

source_encoding:

'utf-8-sig'

source_suffix:

{'.rst': 'restructuredtext'}

sphinx_immaterial_bundle_source_maps:

False

sphinx_immaterial_custom_admonitions:

[]

sphinx_immaterial_generate_extra_admonitions:

True

sphinx_immaterial_icon_path:

[]

sphinx_immaterial_override_builtin_admonitions:

True

sphinx_immaterial_override_generic_admonitions:

True

sphinx_immaterial_override_version_directives:

True

sphinx_tabs_disable_css_loading:

False

sphinx_tabs_disable_tab_closing:

False

sphinx_tabs_valid_builders:

[]

strip_signature_backslash:

False

suppress_warnings:

[]

template_bridge:

None

templates_path:

[]

texinfo_appendices:

[]

texinfo_cross_references:

True

texinfo_domain_indices:

True

texinfo_elements:

{}

texinfo_no_detailmenu:

False

texinfo_show_urls:

'footnote'

text_add_secnumbers:

True

text_newlines:

'unix'

text_secnumber_suffix:

'. '

text_sectionchars:

'*=-~"+`'

tls_cacerts:

None

tls_verify:

True

toc_object_entries:

True

toc_object_entries_show_parents:

'domain'

today:

''

today_fmt:

None

translation_progress_classes:

False

trim_doctest_flags:

True

trim_footnote_reference_space:

False

user_agent:

None

version:

''

xml_pretty:

True