Skip to content

Prepare docs for sub-packages - #165

Merged
leofang merged 14 commits into
NVIDIA:mainfrom
leofang:new_docs
Oct 15, 2024
Merged

Prepare docs for sub-packages#165
leofang merged 14 commits into
NVIDIA:mainfrom
leofang:new_docs

Conversation

@leofang

@leofangleofang commented Oct 12, 2024

Copy link
Copy Markdown
Member

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:

@leofangleofang self-assigned this Oct 12, 2024
@copy-pr-bot

Copy link
Copy Markdown
Contributor

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.

@leofangleofang 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
@leofangleofang added this to the cuda.core beta 1 milestone Oct 12, 2024
@leofang

leofang commented Oct 14, 2024

Copy link
Copy Markdown
MemberAuthor

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.

@leofangleofang mentioned this pull request Oct 14, 2024
@leofang

Copy link
Copy Markdown
MemberAuthor

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

@leofangleofang changed the title WIP: Prepare docs for sub-packagesPrepare docs for sub-packagesOct 15, 2024
@leofang
leofang marked this pull request as ready for review October 15, 2024 17:32
Comment threadcuda_bindings/docs/environment-docs.yml
Comment threadcuda_python/docs/build_all_docs.sh Outdated
Comment threadcuda_python/docs/README.md
Comment threadcuda_python/docs/source/conf.py

@vzhurba01vzhurba01 left a comment

Copy link
Copy Markdown
Contributor

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:mainOct 15, 2024
@leofang
leofang deleted the new_docs branch October 15, 2024 22:49
mdboom pushed a commit to mdboom/cuda-python that referenced this pull request Nov 4, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cuda.bindingsEverything related to the cuda.bindings modulecuda.coreEverything related to the cuda.core moduledocumentationImprovements or additions to documentationP0High 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

@leofang@vzhurba01