get_config fails with any section that is not 'theme' or 'options'

[Carreau]

Describe the bug

See sunpy/ablog#277

in 360c7a8 the following change was introduced:

-        try:
-            return self.config.get(section, name)
-        except (configparser.NoOptionError, configparser.NoSectionError):
-            if self._base:
-                return self._base.get_config(section, name, default)
-
-            if default is _NO_DEFAULT:
-                raise ThemeError(__('setting %s.%s occurs in none of the '
-                                    'searched theme configs') % (section, name)) from None
-            return default
+        if section == 'theme':
+            value = self._settings.get(name, default)
+        elif section == 'options':
+            value = self._options.get(name, default)
+        else:
+            value = _NO_DEFAULT
+        if value is _NO_DEFAULT:
+            msg = __(
+                'setting %s.%s occurs in none of the searched theme configs',
+            ) % (section, name)
+            raise ThemeError(msg)
+        return value

This means that any section name that is not 'theme', or 'options' will raise. Extensions, (typically ablog) use section names that are not 'theme' or 'options', and call get_config with a default values, failing.

https://github.com/sunpy/ablog/blob/b39f90bda1fc2bfddc373f5e5e970201914e1549/src/ablog/__init__.py#L121C14-L121C21

How to Reproduce

Build anything that use ablog as extension with sphin
Build pydata-sphinx-theme docs by default for example

Environment Information

sphinx 7.3.6

Sphinx extensions

ablog

Additional context

No response

[AA-Turner]

Thanks for reporting.

The rationale for the changes is to tighten the theme configuration interface to allow supporting theme.toml. The documentation has never advertised support for other sections, and whilst it has not been prohibited, it is not supported.

We could make the below change to remove the error, but this would mask the true behaviour, as Sphinx 7.3 and newer do have a behavioural change in that these other sections are unsupported.

 else: 
-    value = _NO_DEFAULT
+    value = default

sphinx/sphinx/theming.py

Lines 105 to 130 in 630b4fb

	def get_config(self, section: str, name: str, default: Any = _NO_DEFAULT) -> Any:
	"""Return the value for a theme configuration setting, searching the
	base theme chain.
	"""
	if section == 'theme':
	if name == 'stylesheet':
	value = ', '.join(self.stylesheets) or default
	elif name == 'sidebars':
	value = ', '.join(self.sidebar_templates) or default
	elif name == 'pygments_style':
	value = self.pygments_style_default or default
	elif name == 'pygments_dark_style':
	value = self.pygments_style_dark or default
	else:
	value = default
	elif section == 'options':
	value = self._options.get(name, default)
	else:
	value = _NO_DEFAULT
	if value is _NO_DEFAULT:
	msg = __('setting %s.%s occurs in none of the searched theme configs') % (
	section,
	name,
	)
	raise ThemeError(msg)
	return value

A

[AA-Turner]

4a0c9dd

[AA-Turner]

Sphinx 7.3.7 has been released with fixes.

A

[Carreau]

Thanks for the quick fix !