Skip to content

DOC: No links to prior versions docs #43782

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
1 task done
DrGFreeman opened this issue Sep 28, 2021 · 4 comments · Fixed by #43809
Closed
1 task done

DOC: No links to prior versions docs #43782

DrGFreeman opened this issue Sep 28, 2021 · 4 comments · Fixed by #43809
Labels
Milestone

Comments

@DrGFreeman
Copy link
Contributor

  • I have checked that the issue still exists on the latest versions of the docs on master here

Location of the documentation

https://pandas.pydata.org/docs/index.html

Documentation problem

It is difficult to access the documentation of prior pandas versions. https://pandas.pydata.org/docs/index.html has no links to prior versions docs or they are difficult to find.

When working with legacy code using older pandas versions, access to the docs of a specific version, especially the API reference, can be useful.

While it if possible to find the URL, e.g. https://pandas.pydata.org/pandas-docs/version/0.24.0/ with a bit of trial and error, a list of links to the prior versions docs would be useful.

Suggested fix for documentation

Add a page in the docs with a list of links to prior versions docs.

@DrGFreeman DrGFreeman added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 28, 2021
@DrGFreeman
Copy link
Contributor Author

I'm interested in contributing a PR to add the links on a new page, or elsewhere, if this idea is accepted by the maintainers. Feedback welcome. Thx.

@mroeschke
Copy link
Member

Thanks for the suggestion. Since this suggestion overlaps with #42722, I am going to close this issue in order to consolidate discussion and effort towards that issue. Still happy to have your contribution towards this suggestion!

@DrGFreeman
Copy link
Contributor Author

DrGFreeman commented Sep 29, 2021

@mroeschke, I agree this overlaps with #42722, but I believe the intent and solutions to the two issues are different.

A solution to #42722 would add the current version number in the page header but would not provide access to the documentation of previous versions.

In opposition, a solution to this issue would add information on how to get documentation of previous versions (example below), without information on the current version (except on the index page).

image

Adding a dropdown menu to select the docs version would be a solution to both issues. However, the implementation of such a solution is significantly more complex and, as stated in #42722, probably not worth the effort:

Python also offers a drop down menu to select a specific docs version. I think this is overhead and not needed for pandas.

For the above reasons, I believe the two issues should be dealt with separately. If you agree, I could submit a PR that addresses the current issue with a change as in the above example.

@MarcoGorelli
Copy link
Member

If you agree, I could submit a PR that addresses the current issue with a change as in the above example.

sounds good, feel free to open a PR

@jreback jreback added this to the 1.3.4 milestone Sep 30, 2021
@jreback jreback removed the Needs Triage Issue that has not been reviewed by a pandas team member label Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants