Update link to c++ developer guide #718
Merged
Conversation
This file contains 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
isVoid
added
3 - Ready for Review
harrism
requested changes
Oct 3, 2022
docs/source/developer_guide/index.md
Outdated
| cuSpatial has two main components: the cuSpatial Python package and the `libcuspatial` C++ library, | ||
| referred to as `cuspatial` and `libcuspatial` respectively in this documentation. This page | ||
| discusses the design of `cuspatial`. For information on `libcuspatial`, see the [libcuspatial | ||
| developer guide](https://docs.rapids.ai/api/libcuspatial/nightly/DEVELOPER_GUIDE.html) |
There was a problem hiding this comment.
Please link to the stable...
Is there a way to make these links relative so that the nightly Python user guide links to the nightly C++ user guide, and the stable Python user guide links to the stable C++ user guide?
Suggested change
| developer guide](https://docs.rapids.ai/api/libcuspatial/nightly/DEVELOPER_GUIDE.html) | |
| developer guide](https://docs.rapids.ai/api/libcuspatial/stable/DEVELOPER_GUIDE.html) |
There was a problem hiding this comment.
At least not from the sphinx docs. You would probably need to add some scripts to the nightly build system?
There was a problem hiding this comment.
OK then just always link to the stable docs.
Co-authored-by: Mark Harris <[email protected]>
harrism
approved these changes
Oct 4, 2022
|
@gpucibot merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR moves the library wide overview section to top level
developer guide. And updates link to c++ developer guide. As of creation, the link to c++ developer guide is not published yet. Should verify before merge.Checklist