sphinx_config_schema

import sphinx_config_schema

Render a JSON schema as a copyable TOML, YAML, or JSON example in Sphinx.

OPTION_ROLE_ALIAS = 'cfg'

Short name under which config-schema:option is also registered.

class ConfigSchemaDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: SphinxDirective

Render a copyable TOML, YAML, or JSON example from a JSON schema.

Each key in the example is an anchor that sphinx-tippy turns into a tooltip with the description of that setting and the values that the example does not show.

Submodules and Subpackages

• codeblock
• render
• schema
• tooltips