Pandas version checks

  • [x] I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

Pages under https://pandas.pydata.org/docs/reference/index.html

Documentation problem

I've come across pages in the API reference that have a corresponding Getting Started / User Guide, but don't link to them. (Failing to find an example at the moment.) This is a shame, because the guides are generally more beginner-friendly.

Suggested fix for documentation

I suggest doing a content audit:

  1. Go through each guide.
  2. Click the links to the API docs.
  3. For the API docs that don't link back to the guide, submit a pull request to add them.
  4. Contributing to the documentation
  5. This could be handled by someone else, if someone just wanted to take the first part.

If you wanna get fancy, you could write code to do that šŸ˜‰ No idea how hard that would be with Sphinx.

Comment From: zeyneptezduyar

take

Comment From: zeyneptezduyar

Just to understand the issue better:

We want to have, for each API reference we can get to from the guides OR getting started, a link back. Correct @afeld ?

I can see an example of this being done here: https://pandas.pydata.org/docs/reference/api/pandas.Series.html#pandas.Series

Notes

Please reference the User Guide for more information.

Do we want this for all the missing ones? For instance, I can see it is missing for Index API Reference

Comment From: manikrishna-m

take

Comment From: afeld

for each API reference we can get to from the guides OR getting started, a link back

Maybe not every single one, but where it makes sense, yep.

I can see it is missing for Index API Reference

Coincidentally, I have another open issue around indexes in the Getting Started (https://github.com/pandas-dev/pandas/issues/62358), which would be appropriate to link to from the Indexing API page šŸ‘

Comment From: zeyneptezduyar

Sounds good, thanks for the info!

Comment From: pranavkp71

Hi, Iā€™m new and interested in contributing to pandas docs. I see this issue is already assigned, but if extra help is needed (like checking other API pages for missing links), Iā€™d be happy to assist or pick up a related task.

Comment From: afeld

If folks want to connect with @zeyneptezduyar and divide and conquer, that would be great!