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

Add sphinx-version-warning extension #502

Merged
merged 1 commit into from
Feb 7, 2025
Merged

Add sphinx-version-warning extension #502

merged 1 commit into from
Feb 7, 2025

Conversation

skoech
Copy link
Collaborator

@skoech skoech commented Feb 6, 2025

Description

We need a warning banner for when a user is not on the latest stable version of our documentation. sphinx-version-warning is a Sphinx extension that compares the current version to the latest one and then displays this banner at the top of the documentation page if it is an older version.

Type of change

  • New feature (non-breaking change which adds functionality)
  • Documentation update (Doc only change)

@skoech skoech added the documentation Improvements or additions to documentation label Feb 6, 2025
@lmlg
Copy link
Contributor

lmlg commented Feb 6, 2025

changes look fine. just make sure to rebase against the newest main branch, as some tests are failing due to older actions being used.

@lmlg lmlg merged commit 9ecc402 into main Feb 7, 2025
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants