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 injecting version warning banners (mirroring/above-and-beyond what RtD supports) #803

Open
1 task done
pradyunsg opened this issue May 20, 2024 · 0 comments
Open
1 task done
Labels
enhancement New feature or request

Comments

@pradyunsg
Copy link
Owner

What's happening?

https://github.com/pallets/pallets-sphinx-themes/ has custom JS logic for injecting a version warning banner on top, and the scrolling mechanisms understand how this banner works.

https://github.com/pallets/pallets-sphinx-themes/blob/465f69bda3b4183d99a38b7354de569ff2c79bcb/src/pallets_sphinx_themes/themes/pocoo/static/version_warning_offset.js

It would be possible for pallets-sphinx-themes to be replaced with Furo, to enable those projects to move over. This banner would be supported with something similar to https://github.com/readthedocs/readthedocs.org//issues/9875#issuecomment-1647905630 which reads the information in a manner specific to how various pallets projects handle data injection.

Reproducer

Skipping this for now. Look at the implementation for this and, later, try switching over Flask out of these setups.

Expectation

Skipping this for now. Make this feasible.

Code of Conduct

@pradyunsg pradyunsg added the enhancement New feature or request label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant