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 linkcode to docs #15860

Merged

Conversation

raybellwaves
Copy link
Contributor

@raybellwaves raybellwaves commented May 24, 2024

Description

This PR adds a [source] button in the API docs which allows readers to jump into the code behind the API docs.

This is currently done in pandas e.g. https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html#pandas.DataFrame and below. The code is also copied and modified from the pandas repo (https://github.com/pandas-dev/pandas/blob/main/doc/source/conf.py#L637).

Screenshot 2024-05-24 at 3 57 57 PM

Checklist

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

Copy link

copy-pr-bot bot commented May 24, 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.

@raybellwaves raybellwaves marked this pull request as draft May 24, 2024 20:06
@raybellwaves raybellwaves marked this pull request as ready for review May 24, 2024 21:33
@raybellwaves raybellwaves changed the title WIP: DOC: add linkcode to docs DOC: add linkcode to docs May 24, 2024
@vyasr vyasr added doc Documentation non-breaking Non-breaking change labels May 28, 2024
Copy link
Contributor

@vyasr vyasr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

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

vyasr commented May 28, 2024

/ok to test

@vyasr
Copy link
Contributor

vyasr commented May 29, 2024

/merge

@rapids-bot rapids-bot bot merged commit 7b02f4b into rapidsai:branch-24.08 May 29, 2024
69 of 71 checks passed
This pull request was closed.
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants