-
-
Notifications
You must be signed in to change notification settings - Fork 108
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
Consider having an easier path for older versions of the documentation #293
Comments
I had the same thought as @adeak - I agree that the current default link location (doc/stable) is sensible and probably what most people want, though the It would be nice to have an easier, "more clickable" way to navigate to |
To copy my suggestion from another issue, we could rename the "Docs" button in the navigation bar to "All docs" or something similar. This would make it more obvious that one can find alternative versions there. |
@adeak Agreed, the way it is now isn't the way it should be. We do have a goal of providing smooth access to earlier releases directly from the doc pages. Unfortunately this improvement is bundled with broader structural changes so it's been slow to appear. But I believe we want what you want -- a dropdown menu on the main docs page to pick a version. |
Now that we have adopted the PyData theme, there's a chance the version switcher will be available sometime in the future (see for example https://docs.spyder-ide.org/current/index.html - the Spyder team has mentioned they would be able to help bring that feature upstream) |
A version switcher would be the ultimate solution to this problem. Let's hope it will work out :) |
The version switcher has been added to the top navigation bar of https://numpy.org/doc/stable/. I'm closing the issue. |
@InessaPawson - Can you point to the PR, issue, or commit hash where this work was done? I want to do similar with my projects. |
It is part of the pydata theme we use, and was implemented in a series of PRs I found by searching for switcher |
@mattip Thanks for the links! |
This is probably a feature request.
Currently the straightforward "Documentation" link at numpy.org takes the user to https://numpy.org/doc/stable/ which is the docs of the current stable version. This is what the overwhelming majority of users is looking for, so this is great! But if I'm looking for the dev docs or the docs of a specific older version of numpy, I think I can only find that by clicking on the top "Docs" link and picking the version I need.
I understand that it might not be trivial (from a semantic point of view) to somehow put a direct link to other versions from a version-specific front page of the documentation (currently v1.18). And wanting to have access to specific versions might be niche enough that the current setup will work just fine.
And it also makes sense just having to click that "Docs" link to get other docs versions.
The text was updated successfully, but these errors were encountered: