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

DOC, DX: Remove version warning banner in latest version #20184

Merged
merged 1 commit into from Mar 5, 2024

Conversation

melissawm
Copy link
Contributor

Reference issue

Addresses #19699 (comment)

What does this implement/fix?

Do not include the version warning banner at the top of the pages on "latest".

If I understand the docs release process correctly, once the docs are built for stable, the version warning banner code will be present so that:

  • stable (1.12.0) won't show any banners, but the banner code will be included in the build;
  • once 1.12.X is released, 1.12.0 will show the banner.
  • "latest" will never show the banner.

Additional information

Perhaps @tylerjereddy can confirm the docs building/release process.

@melissawm melissawm requested a review from tupui as a code owner March 4, 2024 16:39
@github-actions github-actions bot added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label Mar 4, 2024
@lucascolley
Copy link
Member

not sure if the refguide-check timeout is related but it shouldn't be

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @melissawm, and thanks for the review @lucascolley. This LGTM, so let's give this a go.

If I understand the docs release process correctly, once the docs are built for stable, the version warning banner code will be present so that:

That sounds right to me.

not sure if the refguide-check timeout is related but it shouldn't be

I reran it just to check if it would time out again, but it didn't That job is downloading data files with pooch, which is the most likely cause of timeouts in the middle of the checker running.

@rgommers rgommers merged commit b926681 into scipy:main Mar 5, 2024
26 checks passed
@rgommers rgommers added this to the 1.13.0 milestone Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants