Sphinx-Immaterial

Index

Sphinx-Immaterial

Index

_ | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W

_

__init__() (test_py_module.test.Foo method)

__weakref__ (test_py_module.test.Foo attribute)

A

B

built-in function

C

ConvertVectorToString (C++ function)
cpp-apigen-entity-summary (directive)
- :notoc: (directive option)
cpp-apigen-group (directive)
- :notoc: (directive option)
cpp_apigen_case_insensitive_filesystem
- configuration value
cpp_apigen_configs
- configuration value
cpp_apigen_rst_epilog
- configuration value
cpp_apigen_rst_prolog
- configuration value
cpp_strip_namespaces_from_signatures
- configuration value
cpp_xref_resolve_c_macro_pattern
- configuration value
cppreference_xml_files
- configuration value
custom_checkbox
- configuration value
CustomAdmonitionConfig (class in sphinx_immaterial.custom_admonitions)

D

E

:exclude_from_toc: (directive option)
- json:schema (directive)
edit
- theme option
edit_uri
- theme option
environment

environment variable
- SPHINX_IMMATERIAL_EXTERNAL_RESOURCE_CACHE_DIR, [1]
- SPHINX_IMMATERIAL_FONT_FETCH_MAX_WORKERS
external_cpp_references
- configuration value
ExternalCppReference (class in sphinx_immaterial.apidoc.cpp.external_cpp_references)
ExtractValueFromJson (C++ function)

F

features
- theme option
feedback
- theme option
file-wide metadata option
- hero
- hide-edit-link
- hide-feedback
- hide-footer
- hide-navigation
- hide-toc
- icon
- show-comments
- status
- subtitle

G

generate_synopses
- object description option
global
- substitutions

globaltoc_collapse
- theme option
graphviz_ignore_incorrect_font_metrics
- configuration value

H

hero
- file-wide metadata option
hide-edit-link
- file-wide metadata option
hide-feedback
- file-wide metadata option
hide-footer
- file-wide metadata option
hide-navigation
- file-wide metadata option

hide-toc
- file-wide metadata option
hide_initializers (sphinx_immaterial.apidoc.cpp.api_parser.Config attribute)
hide_types (sphinx_immaterial.apidoc.cpp.api_parser.Config attribute)
highlight-pop (directive)
highlight-push (directive)
html_logo
- configuration value
html_theme_options
- configuration value

I

include_in_toc
- object description option
include_object_type_in_xref_tooltip
- object description option
include_rubrics_in_toc
- object description option
input_content (sphinx_immaterial.apidoc.cpp.api_parser.Config attribute)
input_path (sphinx_immaterial.apidoc.cpp.api_parser.Config attribute)

J

json:schema (directive)
json:schema (role)
json_schema_rst_epilog
- configuration value

json_schema_rst_prolog
- configuration value
json_schema_validate
- configuration value
json_schemas
- configuration value

K

keys_separator
- configuration value
keys_strict
- configuration value

L

logo
- theme option
long_function_signature_example()
- built-in function
LongFunctionSignatureExample (C++ function)

M

md-mermaid (directive)
- :class: (directive option)
- :name: (directive option)
md-tab-item (directive)
- :class: (directive option)
md-tab-set (directive)
- :class: (directive option)
- :name: (directive option)
media (palette preference)
- theme option
menu
- theme option
ModNested() (class)
ModTopLevel() (class)
module
- test_py_module.test
module_a.submodule (module)

N

:name: (directive option)
:no-title: (directive option)
- admonition (directive)
:noindex: (directive option)
- json:schema (directive)

:notoc: (directive option)
name (sphinx_immaterial.custom_admonitions.CustomAdmonitionConfig attribute)
next
- theme option

O

:output-prefix: (directive option)
- rst-example (directive)
object description option

object_description_options
- configuration value
object_type (sphinx_immaterial.apidoc.cpp.external_cpp_references.ExternalCppReference attribute)
overload_example1()
- built-in function
overload_example2(float)()
- built-in function
overload_example2(int)()
- built-in function
overload_example2(str)()
- built-in function
overloaded_func() (in module test_py_module.test)
override (sphinx_immaterial.custom_admonitions.CustomAdmonitionConfig attribute)

P

palette
- theme option
previous
- theme option
primary
- theme option
Python Enhancement Proposals
- PEP 585
- PEP 604
python-apigen-entity-summary (directive)
- :notoc: (directive option)
python-apigen-group (directive)
- :notoc: (directive option)
python_apigen_case_insensitive_filesystem
- configuration value
python_apigen_default_groups
- configuration value
python_apigen_default_order
- configuration value
python_apigen_modules
- configuration value
python_apigen_order_tiebreaker
- configuration value
python_apigen_rst_epilog
- configuration value

python_apigen_rst_prolog
- configuration value
python_apigen_show_base_classes
- configuration value
python_apigen_subscript_method_types
- configuration value
python_module_names_to_strip_from_xrefs
- configuration value
python_resolve_unqualified_typing
- configuration value
python_strip_property_prefix
- configuration value
python_strip_return_type_annotations
- configuration value
python_strip_self_type_annotations
- configuration value
python_transform_type_annotations_concise_literal
- configuration value
python_transform_type_annotations_pep585
- configuration value
python_transform_type_annotations_pep604
- configuration value
python_transform_typing_extensions
- configuration value
python_type_aliases
- configuration value

Q

qux (test_py_module.test.Foo attribute)

R

repo
- theme option
repo_name
- theme option
repo_url
- theme option

rst-example (directive)

S

scheme
- theme option
scope
- theme option
search
- theme option
share
- theme option
show-comments
- file-wide metadata option
si-icon (role)
site_url
- theme option
social
- theme option
source directory
spam (test_py_module.test.Foo attribute)
Sphinx::version (C++ member)
sphinx_immaterial_bundle_source_maps
- configuration value
sphinx_immaterial_custom_admonitions
- configuration value
SPHINX_IMMATERIAL_EXTERNAL_RESOURCE_CACHE_DIR
sphinx_immaterial_external_resource_cache_dir
- configuration value

sphinx_immaterial_font_fetch_max_workers
- configuration value
sphinx_immaterial_generate_extra_admonitions
- configuration value
sphinx_immaterial_icon_path
- configuration value
sphinx_immaterial_override_builtin_admonitions
- configuration value
sphinx_immaterial_override_generic_admonitions
- configuration value
sphinx_immaterial_override_version_directives
- configuration value
status
- file-wide metadata option
- theme option
std::array (C++ class)
string_normalization (sphinx_immaterial.apidoc.format_signatures.BlackFormatStyle attribute)
substitutions
- global
subtitle
- file-wide metadata option
synopses_ex::Class (C++ class)
synopses_ex::Class::Class (C++ function)
synopses_ex::Foo (C++ function)
synopses_ex::SomeType (C++ type)

T

:title: (directive option)
- admonition (directive)
- json:schema (directive)
:toc_title: (directive option)
- json:schema (directive)
task-list (directive)
test_py_module.test
- module
theme option
- accent
- admonition
- alternate
- analytics
- annotation
- close
- direction
- edit
- edit_uri
- features
- feedback
- font
- globaltoc_collapse
- icon
- languages
- logo
- media (palette preference)
- menu
- next
- palette
- previous
- primary
- repo
- repo_name
- repo_url
- scheme
- scope
- search
- share
- site_url
- social
- status
- toc_title
- toc_title_is_page_title
- toggle
- top
- version_dropdown
- version_info
- version_json
- view

title (sphinx_immaterial.custom_admonitions.CustomAdmonitionConfig attribute)
toc_icon_class
- object description option
toc_icon_text
- object description option
toc_title
- theme option
toc_title_is_page_title
- theme option
toggle
- theme option
top
- theme option
type_replacements (sphinx_immaterial.apidoc.cpp.api_parser.Config attribute)

U

url (sphinx_immaterial.apidoc.cpp.external_cpp_references.ExternalCppReference attribute)

V

verbose (sphinx_immaterial.apidoc.cpp.api_parser.Config attribute)
version (C++ member)
version_dropdown
- theme option
version_info
- theme option

version_json
- theme option
view
- theme option

W

wrap_signatures_column_limit
- object description option

wrap_signatures_with_css
- object description option