Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #10061: html theme: Confvals added by themes are not initialized #10079

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGES
Expand Up @@ -58,6 +58,8 @@ Bugs fixed
* #9878: mathjax: MathJax configuration is placed after loading MathJax itself
* #9857: Generated RFC links use outdated base url
* #9909: HTML, prevent line-wrapping in literal text.
* #10061: html theme: Configuration values added by themes are not be able to
override from conf.py
* #9925: LaTeX: prohibit also with ``'xelatex'`` line splitting at dashes of
inline and parsed literals
* #9944: LaTeX: extra vertical whitespace for some nested declarations
Expand Down
17 changes: 14 additions & 3 deletions sphinx/config.py
Expand Up @@ -251,6 +251,17 @@ def init_values(self) -> None:
if name in self.values:
self.__dict__[name] = config[name]

def post_init_values(self) -> None:
"""
Initialize additional config variables that are added after init_values() called.
"""
config = self._raw_config
for name in config:
if name not in self.__dict__ and name in self.values:
self.__dict__[name] = config[name]

check_confval_types(None, self)

def __getattr__(self, name: str) -> Any:
if name.startswith('_'):
raise AttributeError(name)
Expand Down Expand Up @@ -427,7 +438,7 @@ def check_confval_types(app: "Sphinx", config: Config) -> None:
"but `{current}` is given.")
logger.warning(msg.format(name=confval.name,
current=confval.value,
candidates=annotations.candidates))
candidates=annotations.candidates), once=True)
else:
if type(confval.value) is type(default):
continue
Expand All @@ -452,13 +463,13 @@ def check_confval_types(app: "Sphinx", config: Config) -> None:
permitted = " or ".join(wrapped_annotations)
logger.warning(msg.format(name=confval.name,
current=type(confval.value),
permitted=permitted))
permitted=permitted), once=True)
else:
msg = __("The config value `{name}' has type `{current.__name__}', "
"defaults to `{default.__name__}'.")
logger.warning(msg.format(name=confval.name,
current=type(confval.value),
default=type(default)))
default=type(default)), once=True)


def check_primary_domain(app: "Sphinx", config: Config) -> None:
Expand Down
1 change: 1 addition & 0 deletions sphinx/theming.py
Expand Up @@ -208,6 +208,7 @@ def load_external_theme(self, name: str) -> None:
try:
entry_point = theme_entry_points[name]
self.app.registry.load_extension(self.app, entry_point.module)
self.app.config.post_init_values()
return
except KeyError:
pass
Expand Down