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

Enable version warning banner #7138

Open
1 of 2 tasks
stefanv opened this issue Sep 15, 2023 · 5 comments
Open
1 of 2 tasks

Enable version warning banner #7138

stefanv opened this issue Sep 15, 2023 · 5 comments
Labels
📄 type: Documentation Updates, fixes and additions to documentation

Comments

@stefanv
Copy link
Member

stefanv commented Sep 15, 2023

Description:

#6896 tried to add a version warning banner.

This is now supported by the pydata-sphinx-theme directly: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/announcements.html#version-warning-banners

Way to reproduce:

No response

Version information:

No response

@stefanv stefanv added the 📄 type: Documentation Updates, fixes and additions to documentation label Sep 15, 2023
@lagru
Copy link
Member

lagru commented Sep 16, 2023

I think we have to wait a bit until this bug pydata/pydata-sphinx-theme#1450 is resolved...

@lucascolley
Copy link

lucascolley commented Jan 6, 2024

It looks like the theme website itself has this working for older versions. We're going to try to do this in SciPy once we update our theme version (hopefully imminent).

EDIT: hmm, looks like they only have it working for 0.14.4

@lagru
Copy link
Member

lagru commented Jan 9, 2024

We're going to try to do this in SciPy once we update our theme version (hopefully imminent).

Maybe I'm dense, what will you try? Manual backporting or rebuilding the old docs?

@lucascolley
Copy link

Not sure exactly how yet, but we'll at least do it for current/future versions. One quote from scipy/scipy#19699:

maybe we could indeed get away with manually patching what's already out there (don't really like that, but far less work if it can be done with high degree of safety, and perhaps only last N releases but not too far back)

@stefanv
Copy link
Member Author

stefanv commented Jan 9, 2024

Manual editing is probably easiest. We can add a static banner that points to /stable, or insert a piece of Javascript that renders from the dev docs. I think the static banner is fine, but the latter having the advantage that we can tweak it over time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 type: Documentation Updates, fixes and additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants