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 version warning banner message #1394

Merged
merged 2 commits into from
Jul 27, 2023

Conversation

drammock
Copy link
Collaborator

Fixes 2 problems with the version warning banner:

  1. the grammar was a bit off for cases where the version was unparsable (and thus we couldn't tell if the version was older or newer than preferred)
  2. it was relying on DOCUMENTATION_OPTIONS.VERSION which sometimes is an empty string --- not sure why; on PR builds it is correctly populated but on current dev build it is empty string, yielding this screenshot:

Screenshot 2023-07-26 at 13-44-15 Contributor Guide — PyData Theme documentation

@drammock drammock added kind: bug Something isn't working impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship labels Jul 26, 2023
@drammock
Copy link
Collaborator Author

This one is ready for review/merge. The PR build still looks as expected; the real test will be if https://pydata-sphinx-theme.readthedocs.io/en/latest/index.html shows the banner correctly after this PR is merged.

Copy link
Collaborator

@12rambau 12rambau left a comment

Choose a reason for hiding this comment

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

let's try !

@12rambau 12rambau merged commit 66a826c into pydata:main Jul 27, 2023
@drammock
Copy link
Collaborator Author

it worked :)

Screenshot 2023-07-27 at 10-44-25 The PyData Sphinx Theme — PyData Theme documentation

@drammock drammock deleted the fix-warningbanner-msg branch July 27, 2023 15:44
@12rambau
Copy link
Collaborator

yeah sorry I checked but I'm unable to send Images to Github from my company computer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship kind: bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants