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

Moving some template links to Python #672

Merged
merged 1 commit into from May 25, 2022
Merged

Conversation

choldgraf
Copy link
Collaborator

We currently link two theme-specific things in a Jinja extrahead block:

  • Our favicon links (e.g. for apple icons)
  • Our Google Analytics code

However, some themes over-write the extrahead block, and if they don't realize that this functionality needs to be explicitly included, then it will fail silently. For example:

So this PR switches this to use Sphinx for linking these files, instead of a custom Jinja template. This should make this behavior less brittle.

cc @bryevdv

@bryevdv
Copy link
Contributor

bryevdv commented May 19, 2022

@choldgraf FWIW with the newer favicon support in the theme, we realized we can stop overriding extrahead altogether. However I do think this is a good change, and that having a safe user-addressable block for anything extra that might need injecting is a good feature.

@jarrodmillman jarrodmillman added this to the 0.9 milestone May 25, 2022
@jarrodmillman
Copy link
Collaborator

This LGTM. @choldgraf Any reason to wait on merging this?

@choldgraf
Copy link
Collaborator Author

I'm +1 on merging if nobody finds something wrong with it!

@jarrodmillman
Copy link
Collaborator

Maybe we could merge this, release pydata-sphinx-theme 0.9rc1, and then ask folks to test it. We can wait to finalize 0.9 until we have feedback from folks using google analytics. If that seems reasonable, I propose we:

  1. merge this
  2. rename master to main
  3. release 0.9rc1
  4. ask folks to test it
  5. assuming we find no issues, release 0.9
  6. if we run into issues, quickly release 0.9.1

@choldgraf
Copy link
Collaborator Author

That sounds great to me 🙂

@jarrodmillman jarrodmillman merged commit 09504fa into pydata:master May 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants