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.

Sign up for GitHub

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

Jump to bottom

Merge docs and add links #415

Merged
merged 4 commits into from
Oct 5, 2022
Merged

Merge docs and add links #415

merged 4 commits into from
Oct 5, 2022

Conversation

jakirkham
Copy link
Member

Fixes #397
Fixes #395

  • Symlinks top-level README and CHANGELOG into python/cucim/
  • Adds links to the developer page on PyPI and Anaconda
  • Also adds links for docs, source, etc.

cc @grlee77 @gigony

@jakirkham jakirkham requested review from a team as code owners October 4, 2022 20:29
@jakirkham jakirkham added doc Improvements or additions to documentation improvement Improves an existing functionality non-breaking Introduces a non-breaking change and removed doc Improvements or additions to documentation labels Oct 4, 2022
@jakirkham jakirkham added this to the v22.10.00 milestone Oct 4, 2022
This was referenced Oct 4, 2022
Closed
Closed
gigony
gigony approved these changes Oct 4, 2022
View reviewed changes
Copy link
Contributor

@gigony gigony left a comment

Choose a reason for hiding this comment

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

Looks good to me.
Thank you John!
Now we don't need to maintain README/CHANGELOG.md for PyPI package :)

@jakirkham
Copy link
Member Author

Also confirmed that running python setup.py sdist resolved the symlinks correctly to include the README.md and the CHANGELOG.md in the sdist produced.

With python setup.py bdist_wheel, this content gets copied into the METADATA file included in the .whl.

@jakirkham
Copy link
Member Author

rerun tests

(CI had some issue pulling from the repo)

@jakirkham
Copy link
Member Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 0de4b89 into rapidsai:branch-22.10 Oct 5, 2022
@jakirkham jakirkham deleted the merge_docs_and_add_links branch October 5, 2022 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gigony gigony gigony approved these changes

@jolorunyomi jolorunyomi jolorunyomi approved these changes

Assignees
No one assigned
Labels
improvement Improves an existing functionality non-breaking Introduces a non-breaking change
Projects
None yet
Milestone
v22.10.00
Development

Successfully merging this pull request may close these issues.

Two READMEs & CHANGELOGs? Add link to developer page
3 participants
@jakirkham @gigony @jolorunyomi