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]: Move build instructions to dev guide #999

Merged
merged 8 commits into from
Mar 20, 2023

Conversation

jarmak-nv
Copy link
Contributor

Description

Contributes to #908 and unblocks #977

This PR moves the existing build from source instructions to the developer docs page. It does not make any changes to the instructions.

Checklist

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

@jarmak-nv jarmak-nv requested review from isVoid and thomcom March 17, 2023 18:01
@jarmak-nv jarmak-nv self-assigned this Mar 17, 2023
@jarmak-nv jarmak-nv added doc Documentation non-breaking Non-breaking change labels Mar 17, 2023
@jarmak-nv jarmak-nv mentioned this pull request Mar 17, 2023
9 tasks
Copy link
Contributor

@isVoid isVoid left a comment

Choose a reason for hiding this comment

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

Sorry for the late review. Can you also add an item in the toctree of developer_guide/index.md, build?

@jarmak-nv
Copy link
Contributor Author

Added build to the toctree!

@jarmak-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 1728738 into rapidsai:branch-23.04 Mar 20, 2023
rapids-bot bot pushed a commit that referenced this pull request Mar 21, 2023
Closes #908 

With all of the development on cuSpatial, it's time for a new README that is both more up-to-date, and more aligned with other RAPIDS READMEs.
### Outstanding tasks
- [x] Add function hyperlinks
- [x] Move `build from source` instructions to developer docs
  - [x] Remove from readme
  - [x] #999
- [x] Consider adding visuals for things like distances using [GitHub topojson](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-geojson-and-topojson-maps)
- [x] #987

Authors:
  - Ben Jarmak (https://github.com/jarmak-nv)

Approvers:
  - H. Thomson Comer (https://github.com/thomcom)
  - Mark Harris (https://github.com/harrism)
  - Michael Wang (https://github.com/isVoid)

URL: #977
@jarmak-nv jarmak-nv deleted the Build-From-Source-To-Docs branch June 5, 2023 18:51
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
Status: Review
Development

Successfully merging this pull request may close these issues.

3 participants