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

readthedocs shows warning on homepage #460

Open
freemansw1 opened this issue Oct 21, 2024 · 0 comments
Open

readthedocs shows warning on homepage #460

freemansw1 opened this issue Oct 21, 2024 · 0 comments
Labels
bug Code that is failing or producing the wrong result

Comments

@freemansw1
Copy link
Member

It seems that readthedocs is now putting a pesky warning on the documentation pages that are on latest by default (see screenshot). This isn't necessarily a bug, but this is not ideal behavior.

We have a few options on how to fix this. The simplest is to set the documentation page to be on the latest release by default, instead of the latest commit. This would have the additional advantage of us being able to sunset the RC branches for minor version updates, moving main to more similar to what (most) other packages do. We'd still keep it for things like the xarray transition.

Another option, of course, is to change documentation providers/formats. I think that's something we will want to do medium-term anyway, but our current team is very bandwidth limited, so now is not the best time to do that.

Finally, we could do nothing. The warning isn't that annoying.

image

@freemansw1 freemansw1 added the bug Code that is failing or producing the wrong result label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Code that is failing or producing the wrong result
Projects
None yet
Development

No branches or pull requests

1 participant