Skip to content

Banner: warn users on latest they're looking at dev docs and link to stable #6884

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

Closed
mdeff opened this issue Apr 9, 2020 · 5 comments
Closed
Labels
Improvement Minor improvement to code Needed: more information A reply from issue author is required

Comments

@mdeff
Copy link

mdeff commented Apr 9, 2020

I've had multiple issues opened by users reading docs from latest (I don't know how they arrived there, maybe through a web search) without realizing those were for the development version, not the version they installed with pip or conda.

Could we extend the version banner to warn anytime people are not viewing stable? I've seen the discussion in #3481, where it's argued that this is complicated in general. I agree. But I think latest being the developement version is quite common. I'd propose three options for the banner:

  1. no banner (or do it yourself)
  2. banner warns on old and redirects to stable (what we have now)
  3. banner warns on old and latest and redirects to stable (would cover many use cases in my opinion)

Example message from PyTorch.
20200409_160410

@stsewd
Copy link
Member

stsewd commented Apr 9, 2020

You can do 1 with https://github.com/humitos/sphinx-version-warning.

banner warns on old and latest and redirects to stable (would cover many use cases in my opinion)

I think we didn't do that because every project wants to be able to customize the wording and where to put the message, so is hard to cover all of these cases.

@stsewd stsewd added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Apr 9, 2020
@mdeff
Copy link
Author

mdeff commented Apr 9, 2020

I think a standard default would help a lot. The documentation could then redirect to https://github.com/humitos/sphinx-version-warning (or alternatives) for customization.

@humitos
Copy link
Member

humitos commented Apr 9, 2020

@mdeff Hi! We already have a warning banner implemented inside RTD (you can enable it from your admin's project). Although, as @stsewd said, it didn't cover all the cases and people had different ideas of what it was the best.

I implemented sphinx-version-warning as an high customizable alternative so each owner can show the banner where they like and how they like.

I'm afraid that we are not going to change RTD internal's behavior, but I'm happy to read any suggestion that you may have about that extension in case you find it useful for your use case.

@humitos humitos added Needed: more information A reply from issue author is required and removed Needed: design decision A core team decision is required labels Apr 9, 2020
@rmarzocchi84
Copy link

I have tried the a warning banner implemented inside RTD, but it do not show nothing. There is some option in the conf.py to set?

@no-response
Copy link

no-response bot commented Apr 23, 2020

This issue has been automatically closed because there has been no response to our request for more information from the original author. With only the information that is currently in the issue, we don't have enough information to take action. Please reach out if you have or find the answers we need so that we can investigate further. Thanks!

@no-response no-response bot closed this as completed Apr 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: more information A reply from issue author is required
Projects
None yet
Development

No branches or pull requests

4 participants