Skip to content

Commit

Permalink
FIX: Get theme options in a more robust way (#1214)
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf authored Feb 23, 2023
1 parent 5ab7536 commit 686a27a
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions src/pydata_sphinx_theme/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,22 @@
logger = logging.getLogger(__name__)


def _get_theme_options(app):
"""Return theme options for the application w/ a fallback if they don't exist.
In general we want to modify app.builder.theme_options if it exists, so prefer that first.
"""
if hasattr(app.builder, "theme_options"):
# In most HTML build cases this will exist except for some circumstances (see below).
return app.builder.theme_options
elif hasattr(app.config, "html_theme_options"):
# For example, linkcheck will have this configured but won't be in builder obj.
return app.config.html_theme_options
else:
# Empty dictionary as a fail-safe.
return {}


def _config_provided_by_user(app, key):
"""Check if the user has manually provided the config."""
return any(key in ii for ii in [app.config.overrides, app.config._raw_config])
Expand All @@ -43,7 +59,7 @@ def update_config(app):
# At this point, modifying app.config.html_theme_options will NOT update the
# page's HTML context (e.g. in jinja, `theme_keyword`).
# To do this, you must manually modify `app.builder.theme_options`.
theme_options = app.builder.theme_options
theme_options = _get_theme_options(app)

# TODO: deprecation; remove after 0.14 release
if theme_options.get("logo_text"):
Expand Down Expand Up @@ -926,7 +942,7 @@ def _overwrite_pygments_css(app, exception=None):
style_key = f"pygment_{light_or_dark}_style"

# globalcontext sometimes doesn't exist so this ensures we do not error
theme_name = app.builder.theme_options.get(style_key, None)
theme_name = _get_theme_options(app).get(style_key, None)
if theme_name is None and hasattr(app.builder, "globalcontext"):
theme_name = app.builder.globalcontext.get(f"theme_{style_key}")

Expand Down Expand Up @@ -1143,7 +1159,7 @@ def copy_logo_images(app: Sphinx, exception=None) -> None:
If logo image paths are given, copy them to the `_static` folder
Then we can link to them directly in an html_page_context event
"""
theme_options = app.builder.theme_options
theme_options = _get_theme_options(app)
logo = theme_options.get("logo", {})
staticdir = Path(app.builder.outdir) / "_static"
for kind in ["light", "dark"]:
Expand Down

0 comments on commit 686a27a

Please sign in to comment.