search

jbms / sphinx-immaterial

Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system
https://jbms.github.io/sphinx-immaterial/
Other
191 stars 29 forks source link

logo and favicon template variables renamed #209

Closed 2bndy5 closed 1 year ago

2bndy5 commented 1 year ago

regarding sphinx-doc/sphinx#11062

Apparently, we need to update our HTML template (or maybe just the context passed to jinja) for sphinx v6 regarding logo (now named logo_url) and favicon (now named favicon_url). I'm not too concerned with backward compatibility since these changes were accessible from v4.0 and this theme is pinned to sphinx>=4.0.

Notice the specified logo image is not used in our recent docs' update; favicons seem to be cached by my browser, so I'm still seeing the expected favicon. https://jbms.github.io/sphinx-immaterial

I think someone upstream messed up in a way that prevented the deprecation warning from showing because this actually surprised me.

2bndy5 commented 1 year ago

It turns out that the templates were already using the favicon_url var. But the logo_url was getting skipped because the template only checked for the presence of a logo var before using the logo_url var.