Resolving unlinked type shorthands in cudf doc - #7416
Merged
Conversation
isVoid
added
3 - Ready for Review
isVoid
added
2 - In Progress
isVoid
added
3 - Ready for Review
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.
|
shwina
reviewed
Mar 1, 2021
| 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"), |
Contributor
There was a problem hiding this comment.
Both elements of the tuple here are the same -- is that intended?
Contributor
Author
There was a problem hiding this comment.
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.
shwina
reviewed
Mar 1, 2021
Contributor
|
@gpucibot merge |
shwina
approved these changes
Mar 8, 2021
Contributor
|
@gpucibot merge |
hyperbolic2346
pushed a commit
to hyperbolic2346/cudf
that referenced
this pull request
Mar 25, 2021
Closes NVIDIA#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: NVIDIA#7416
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.StringColumncupyAPI reference is added to intersphinx.Minor changes:
frame.copy