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

Prepare docs for sub-packages #165

Merged
merged 14 commits into from
Oct 15, 2024
Merged

Prepare docs for sub-packages #165

merged 14 commits into from
Oct 15, 2024

Conversation

leofang
Copy link
Member

@leofang leofang commented Oct 12, 2024

Close #94. Close #95.

This PR prepares for the documentation infrastructure for adding sub-packages. This introduces a (hopefully one-time only) breaking change to the existing doc urls. Two major changes are:

Old urls:

New urls:

@leofang leofang self-assigned this Oct 12, 2024
Copy link

copy-pr-bot bot commented Oct 12, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@leofang leofang added documentation Improvements or additions to documentation P0 High priority - Must do! cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module labels Oct 12, 2024
@leofang leofang added this to the cuda.core beta 1 milestone Oct 12, 2024
@leofang
Copy link
Member Author

leofang commented Oct 14, 2024

This should be ready for review. However, do not merge yet, as I need to do a live demo first before we commit to the changes.

@leofang
Copy link
Member Author

leofang commented Oct 15, 2024

(Updated the PR description to compare the old/existing urls with the new/expected urls.)

@leofang leofang changed the title WIP: Prepare docs for sub-packages Prepare docs for sub-packages Oct 15, 2024
@leofang leofang marked this pull request as ready for review October 15, 2024 17:32
cuda_python/docs/build_all_docs.sh Outdated Show resolved Hide resolved
cuda_python/docs/README.md Outdated Show resolved Hide resolved
cuda_python/docs/source/conf.py Show resolved Hide resolved
Copy link
Collaborator

@vzhurba01 vzhurba01 left a comment

Choose a reason for hiding this comment

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

LGTM

@leofang leofang merged commit d809deb into NVIDIA:main Oct 15, 2024
@leofang leofang deleted the new_docs branch October 15, 2024 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P0 High priority - Must do!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable versioned doc support Figure out how to make docs of cuda.core and cuda.bindings coexist
2 participants