-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
No warning banner displayed for pre-release versions #4327
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
Comments
RTD doesn't show the warning banner in pre-release versions because this is marked as a higher version, not as an old one. |
Hi @sloria! Thanks for your raising this issue. There is a lot of discussion around the warning banner in #3481. Because of all the different cases, we added that option you found which is marked in False by default since it's very complex to support all the different cases the projects need. Also, I started a personal small sphinx extension to test these different cases. I didn't work too much yet on it and it didn't work dynamically yet, but it's a starting point. You can check it out at https://github.com/humitos/sphinx-version-warning I think we are not going to add more work around the warning banner inside the RTD code, but I want to work on that extension when I have some free time. I will close this issue here, but feel free to reopen or give us feedback here. |
Thanks for the quick replies. @humitos I'll check out your extension and the discussion in #3481. We're considering adding version warnings in the marshmallow docs (marshmallow-code/marshmallow#866 (comment)). |
Details
I have the "Show warning banner" option checked in Admin.
Expected Result
A warning banner on pre-release docs.
Actual Result
No warning banner is displayed.
The text was updated successfully, but these errors were encountered: