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

DOC: add pandas intersphinx mapping #15531

Merged

Conversation

raybellwaves
Copy link
Contributor

@raybellwaves raybellwaves commented Apr 14, 2024

This PR add pandas to intersphinx mapping to make it easy to link to pandas docs from the RAPIDS docs.

There is likely other opportunities to use the pandas intersphinx mapping e.g. #15383 but I think they can be subsequent PRs.

I've tested this locally and confirm it works as expected (i.e. the note in the docstring at https://docs.rapids.ai/api/cudf/stable/user_guide/api_docs/api/cudf.dataframe.query/#cudf.DataFrame.query is now hyperlinked to https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.query.html

Screenshot 2024-04-14 at 2 15 33 AM

Apologies about the other linting. I can revert if need be

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@raybellwaves raybellwaves requested a review from a team as a code owner April 14, 2024 06:16
Copy link

copy-pr-bot bot commented Apr 14, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions github-actions bot added the Python Affects Python cuDF API. label Apr 14, 2024
@galipremsagar
Copy link
Contributor

/okay to test

@mroeschke mroeschke added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change doc Documentation labels Apr 15, 2024
@galipremsagar galipremsagar removed the improvement Improvement / enhancement to an existing function label Apr 16, 2024
@galipremsagar
Copy link
Contributor

/okay to test

docs/cudf/source/conf.py Outdated Show resolved Hide resolved
@galipremsagar
Copy link
Contributor

/okay to test

@galipremsagar
Copy link
Contributor

/merge

@rapids-bot rapids-bot bot merged commit cb8e434 into rapidsai:branch-24.06 Apr 18, 2024
76 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change Python Affects Python cuDF API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants