Skip to content

[doc-only] docs(core): add 1.1.0 to version switcher#2314

Merged
leofang merged 2 commits into
NVIDIA:mainfrom
Andy-Jost:ajost/core-docs-nv-versions-1.1.0
Jul 7, 2026
Merged

[doc-only] docs(core): add 1.1.0 to version switcher#2314
leofang merged 2 commits into
NVIDIA:mainfrom
Andy-Jost:ajost/core-docs-nv-versions-1.1.0

Conversation

@Andy-Jost

Copy link
Copy Markdown
Contributor

Summary

Prepares the cuda.core docs version switcher for the v1.1.0 release and removes a legacy file that is no longer consumed. Part of the v1.1.0 release checklist (#2291), item "Update the docs for the new version".

Changes

  • Add a 1.1.0 entry to cuda_core/docs/nv-versions.json (right after latest), following the existing pattern documented in .github/RELEASE-core.md. Also backfill the missing 1.0.2 entry, which was skipped when 1.0.2 shipped.
  • Delete cuda_core/docs/versions.json and its cp step in cuda_core/docs/build_docs.sh. The Sphinx version switcher configured in cuda_core/docs/source/conf.py reads only nv-versions.json; nothing references versions.json, and it had been stale since 0.3.2. Its copy step merely published a dead file into build/html.

Test Coverage

Docs-only change. nv-versions.json validated as well-formed JSON. pre-commit run --all-files passes.

Related Work

Release checklist: #2291

Add the 1.1.0 entry (and backfill the missing 1.0.2) to
cuda_core/docs/nv-versions.json, which drives the docs version switcher.

Also remove the legacy cuda_core/docs/versions.json and its copy step in
build_docs.sh. The Sphinx switcher (conf.py) reads only nv-versions.json;
nothing consumes versions.json, and it had been stale since 0.3.2.
@Andy-Jost Andy-Jost added this to the cuda.core v1.1.0 milestone Jul 7, 2026
@Andy-Jost Andy-Jost added documentation Improvements or additions to documentation cuda.core Everything related to the cuda.core module labels Jul 7, 2026
@Andy-Jost Andy-Jost self-assigned this Jul 7, 2026
@Andy-Jost Andy-Jost requested review from leofang and mdboom July 7, 2026 19:12
@Andy-Jost Andy-Jost added the P0 High priority - Must do! label Jul 7, 2026
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

Comment thread cuda_core/docs/nv-versions.json Outdated
Comment on lines +10 to +13
{
"version": "1.0.2",
"url": "https://nvidia.github.io/cuda-python/cuda-core/1.0.2/"
},

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think we've shipped 1.0.2?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

My bad: there was a reference to 1.0.2.dev110+g... in _version.py that threw me off

make html

# to support version dropdown menu
cp ./versions.json build/html

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this is still needed when switching to the older versions that used a different Sphinx theme. When we purge the old docs we can clean this up.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

ok, I retained this

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto let's keep it for now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Reverted — versions.json is restored. Left it in place for the older Sphinx-theme docs.

Per review: restore versions.json and its copy step in build_docs.sh
(still consumed by older docs built with the previous Sphinx theme),
and drop the 1.0.2 nv-versions.json entry since 1.0.2 has not shipped
(no tag, not on PyPI). The PR now only adds the 1.1.0 switcher entry.
@Andy-Jost

Copy link
Copy Markdown
Contributor Author

This change should be ready to go now

@Andy-Jost Andy-Jost requested a review from leofang July 7, 2026 20:46
@Andy-Jost Andy-Jost changed the title docs(core): add 1.1.0 to version switcher and drop stale versions.json [doc-only] docs(core): add 1.1.0 to version switcher Jul 7, 2026
@leofang

leofang commented Jul 7, 2026

Copy link
Copy Markdown
Member

Thanks, Andy, let's admin-merge

@leofang leofang merged commit feb5ed4 into NVIDIA:main Jul 7, 2026
104 checks passed
@Andy-Jost Andy-Jost deleted the ajost/core-docs-nv-versions-1.1.0 branch July 7, 2026 21:19
github-actions Bot pushed a commit that referenced this pull request Jul 8, 2026
Removed preview folders for the following PRs:
- PR #1615
- PR #2249
- PR #2255
- PR #2309
- PR #2314
- PR #2316
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

2 participants