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

Non-latest version warning: implement a theme-agnostic banner #9

Closed
humitos opened this issue Mar 15, 2023 · 2 comments
Closed

Non-latest version warning: implement a theme-agnostic banner #9

humitos opened this issue Mar 15, 2023 · 2 comments
Assignees

Comments

@humitos
Copy link
Member

humitos commented Mar 15, 2023

Our current non-latest version warning is pretty nice integrated with the Read the Docs Sphinx theme and that's fine.

Screenshot_2023-03-15_15-49-12

However, we need a generic integration that works good for all the styles. This could be achieved by injecting a fixed banner instead, like the one that's used by Flask:

204576555-8495fc25-a5ee-488f-b01b-f04ef41bbf0d

I think the default banner should be the generic one and theme authors should be able to define where this chunk of HTML will be injected by defining a <div id="non-latest-version-warning"></div> in case they want to integrate it in a nicer way. Similar to what we do with the flyout (https://docs.readthedocs.io/en/stable/flyout-menu.html)

(grabbed from readthedocs/readthedocs.org#9755 (comment))

@humitos
Copy link
Member Author

humitos commented Mar 24, 2023

This will probably follow the same style than #18. I think we will reuse the HTML structure and CSS style for this banner as well.

@humitos humitos self-assigned this Mar 25, 2023
@humitos
Copy link
Member Author

humitos commented Apr 6, 2023

We already decide how we are going to do this. There is a lot of progress in #37. We will re-use that idea to do this warning as well.

@humitos humitos closed this as completed Apr 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

1 participant