Skip to content

Enable injecting version warning banners (mirroring/above-and-beyond what RtD supports) #803

Open
@pradyunsg

Description

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

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions