Examples¶

Live demos¶

This page also uses sphinx-autodoc-docutils to document the config-doc directives themselves, so the page demonstrates both config-value output and directive documentation.

Render a single demo config value¶

demo_debug config env config env demo_debug

Type:: bool
Default:: False
Registered by:: sphinx_config_single_demo.setup()

Bulk config values demo¶

Renders all config values from a module at once:

demo_theme_accent ¶ config html config html demo_theme_accent ¶

Type:: dict
Default:: {'light': 'mint', 'dark': 'teal'}
Registered by:: sphinx_config_demo.setup()

demo_show_callouts ¶ config html config html demo_show_callouts ¶

Type:: bool
Default:: True
Registered by:: sphinx_config_demo.setup()