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

Version switcher provides explicit URLs #604

Merged
merged 4 commits into from Mar 10, 2022

Conversation

choldgraf
Copy link
Collaborator

This removes the url_template parameter of our version switcher, and instead has users explicitly give a URL for each of the versions specified in their version switcher JSON.

closes #600

Copy link
Collaborator

@damianavila damianavila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I like the explicitness of the approach.

Copy link
Collaborator

@damianavila damianavila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After fixing the merge conflicts, I realized one docs json snippet should be updated.

@damianavila
Copy link
Collaborator

@choldgraf, pushed a new commit after fixing the merge conflicts, feel free to re-review and merge this one.

@choldgraf
Copy link
Collaborator Author

Thanks @damianavila ! Just to confirm, I believe that @tupui was 👍 on this change - if anybody else objects please weigh in. Otherwise I'll merge this in a day or two.

@tupui
Copy link
Contributor

tupui commented Mar 7, 2022

Yes I am 👍 Thanks for doing this! Can't wait to use it.

@choldgraf choldgraf merged commit 66f491d into pydata:master Mar 10, 2022
@choldgraf choldgraf deleted the no-interpolation-dropdown branch March 10, 2022 04:04
@choldgraf choldgraf mentioned this pull request Mar 25, 2022
@larsoner
Copy link
Contributor

larsoner commented May 6, 2022

In the future when options are removed, it might be worth emitting a warning in the sphinx build. If I had seen a message like:

WARNING: The configuration variable html_theme_options['switcher']['url_template'] is no longer supported, set URLs in JSON directly

it would have saved me a bit of pain.

Also the failures are silent currently as our links are now to https://mne.tools/undefinedindex.html for example rather than what they were before (e.g., https://mne.tools/0.22)

@choldgraf
Copy link
Collaborator Author

oops - sorry that this created some pain for you. Maybe I was mistaken but I thought we had not yet released this feature which is why I didn't think to deprecate it...I might have missed a release though :-/

@larsoner
Copy link
Contributor

larsoner commented May 6, 2022

It looks like pandas hit it and their workaround was to pin to 8.0.0, so it was probably in there? Not sure though...

@choldgraf
Copy link
Collaborator Author

yep you are correct, my bad :-(

https://github.com/pydata/pydata-sphinx-theme/releases/tag/v0.8.0

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.

Drop the switcher template URL interpolation, and ask users to provide explicit URLs
4 participants