-
Notifications
You must be signed in to change notification settings - Fork 908
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
Resolving unlinked type shorthands in cudf doc #7416
Conversation
Codecov Report
@@ Coverage Diff @@
## branch-0.19 #7416 +/- ##
==============================================
Coverage ? 82.26%
==============================================
Files ? 101
Lines ? 17244
Branches ? 0
==============================================
Hits ? 14185
Misses ? 3059
Partials ? 0 Continue to review full report at Codecov.
|
reftarget_aliases = { | ||
"cudf.Series": ("cudf.core.series.Series", "cudf.Series"), | ||
"cudf.Index": ("cudf.core.index.Index", "cudf.Index"), | ||
"cupy.core.core.ndarray": ("cupy.ndarray", "cupy.ndarray"), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both elements of the tuple here are the same -- is that intended?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, because in cupy
sphinx doc cupy.core.core.ndarray
is mapped to cupy.ndarray
. This is to link to the right entry. The second item is just the display text.
@gpucibot merge |
@gpucibot merge |
Closes rapidsai#7320 This PR adds an additional preprocessing step in documentation generation. It traverses through the doctree generated by Sphinx and replaces unresolved type short hands with proper target reference, while keeping the shortened name for display text. An additional preprocessing step is added to ignore internal types to APIs facing both internally and externally, such as `cudf.core.column.string.StringColumn` `cupy` API reference is added to intersphinx. Minor changes: - Fixes a small doc bug in `frame.copy` Authors: - Michael Wang (@isVoid) Approvers: - Ashwin Srinath (@shwina) URL: rapidsai#7416
Closes #7320
This PR adds an additional preprocessing step in documentation generation. It traverses through the doctree generated by Sphinx and replaces unresolved type short hands with proper target reference, while keeping the shortened name for display text.
An additional preprocessing step is added to ignore internal types to APIs facing both internally and externally, such as
cudf.core.column.string.StringColumn
cupy
API reference is added to intersphinx.Minor changes:
frame.copy