From e7ee8f01f465b736917fbc3c147cd44b2697a1fd Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 21 Aug 2025 02:08:34 +0000
Subject: [PATCH 1/8] Initial plan
From 6b88372ab2299b5b4400662ceae7513bd5994af6 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 21 Aug 2025 02:22:39 +0000
Subject: [PATCH 2/8] Switch to nvidia-sphinx-theme and update version JSON
format
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
---
.../_static/javascripts/version_dropdown.js | 61 -------------------
.../_templates/sidebar/variant-selector.html | 24 --------
cuda_bindings/docs/source/conf.py | 30 +++------
cuda_bindings/docs/versions.json | 39 +++++++++---
.../_static/javascripts/version_dropdown.js | 61 -------------------
.../_templates/sidebar/variant-selector.html | 24 --------
cuda_core/docs/source/conf.py | 30 +++------
cuda_core/docs/versions.json | 39 +++++++++---
cuda_python/docs/environment-docs.yml | 3 +-
.../_static/javascripts/version_dropdown.js | 61 -------------------
.../_templates/sidebar/variant-selector.html | 24 --------
cuda_python/docs/source/conf.py | 30 +++------
cuda_python/docs/versions.json | 39 +++++++++---
13 files changed, 122 insertions(+), 343 deletions(-)
delete mode 100644 cuda_bindings/docs/source/_static/javascripts/version_dropdown.js
delete mode 100644 cuda_bindings/docs/source/_templates/sidebar/variant-selector.html
delete mode 100644 cuda_core/docs/source/_static/javascripts/version_dropdown.js
delete mode 100644 cuda_core/docs/source/_templates/sidebar/variant-selector.html
delete mode 100644 cuda_python/docs/source/_static/javascripts/version_dropdown.js
delete mode 100644 cuda_python/docs/source/_templates/sidebar/variant-selector.html
diff --git a/cuda_bindings/docs/source/_static/javascripts/version_dropdown.js b/cuda_bindings/docs/source/_static/javascripts/version_dropdown.js
deleted file mode 100644
index 9348d2bf84..0000000000
--- a/cuda_bindings/docs/source/_static/javascripts/version_dropdown.js
+++ /dev/null
@@ -1,61 +0,0 @@
-// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
-// SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
-
-function change_current_version(event) {
- event.preventDefault();
-
- var selectedVersion = event.target.textContent;
- var currentVersion = document.getElementById('currentVersion');
-
- // need to update both the on-screen state and the internal (persistent) storage
- currentVersion.textContent = selectedVersion;
- sessionStorage.setItem("currentVersion", selectedVersion);
-
- // Navigate to the clicked URL
- window.location.href = event.target.href;
-}
-
-
-function add_version_dropdown(jsonLoc, targetLoc, currentVersion) {
- var otherVersionsDiv = document.getElementById('otherVersions');
-
- fetch(jsonLoc)
- .then(function(response) {
- return response.json();
- })
- .then(function(data) {
- var versions = data;
-
- if (Object.keys(versions).length >= 1) {
- var dlElement = document.createElement('dl');
- var dtElement = document.createElement('dt');
- dtElement.textContent = 'Versions';
- dlElement.appendChild(dtElement);
-
- for (var ver in versions) {
- var url = versions[ver];
- var ddElement = document.createElement('dd');
- var aElement = document.createElement('a');
- aElement.setAttribute('href', targetLoc + url);
- aElement.textContent = ver;
-
- if (ver === currentVersion) {
- var strongElement = document.createElement('strong');
- strongElement.appendChild(aElement);
- aElement = strongElement;
- }
-
- ddElement.appendChild(aElement);
- // Attach event listeners to version links
- ddElement.addEventListener('click', change_current_version);
- dlElement.appendChild(ddElement);
- }
-
- otherVersionsDiv.innerHTML = '';
- otherVersionsDiv.appendChild(dlElement);
- }
- })
- .catch(function(error) {
- console.error('Error fetching version.json:', error);
- });
-}
diff --git a/cuda_bindings/docs/source/_templates/sidebar/variant-selector.html b/cuda_bindings/docs/source/_templates/sidebar/variant-selector.html
deleted file mode 100644
index b041194c50..0000000000
--- a/cuda_bindings/docs/source/_templates/sidebar/variant-selector.html
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
- cuda-bindings
- v: {{ version }}
-
-
-
-
-
-
-
-
-
diff --git a/cuda_bindings/docs/source/conf.py b/cuda_bindings/docs/source/conf.py
index c156cb4ccf..8c8673a001 100644
--- a/cuda_bindings/docs/source/conf.py
+++ b/cuda_bindings/docs/source/conf.py
@@ -59,27 +59,17 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_baseurl = "docs"
-html_theme = "furo"
-# html_theme = 'pydata_sphinx_theme'
+html_theme = "nvidia_sphinx_theme"
html_theme_options = {
- "light_logo": "logo-light-mode.png",
- "dark_logo": "logo-dark-mode.png",
- # For pydata_sphinx_theme:
- # "logo": {
- # "image_light": "_static/logo-light-mode.png",
- # "image_dark": "_static/logo-dark-mode.png",
- # },
- # "switcher": {
- # "json_url": "https://nvidia.github.io/cuda-python/cuda-bindings/versions.json",
- # "version_match": release,
- # },
- ## Add light/dark mode and documentation version switcher
- # "navbar_end": [
- # "search-button",
- # "theme-switcher",
- # "version-switcher",
- # "navbar-icon-links",
- # ],
+ "switcher": {
+ "json_url": "https://nvidia.github.io/cuda-python/cuda-bindings/versions.json",
+ "version_match": release,
+ },
+ # Add light/dark mode and documentation version switcher
+ "navbar_center": [
+ "version-switcher",
+ "navbar-nav",
+ ],
}
if os.environ.get("CI"):
if int(os.environ.get("BUILD_PREVIEW", 0)):
diff --git a/cuda_bindings/docs/versions.json b/cuda_bindings/docs/versions.json
index 76c66eca88..0031e6238a 100644
--- a/cuda_bindings/docs/versions.json
+++ b/cuda_bindings/docs/versions.json
@@ -1,9 +1,30 @@
-{
- "latest" : "latest",
- "13.0.1" : "13.0.1",
- "13.0.0" : "13.0.0",
- "12.9.0" : "12.9.0",
- "12.8.0" : "12.8.0",
- "12.6.2" : "12.6.2",
- "12.6.1" : "12.6.1"
-}
+[
+ {
+ "version": "latest",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/latest/"
+ },
+ {
+ "version": "13.0.1",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/13.0.1/"
+ },
+ {
+ "version": "13.0.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/13.0.0/"
+ },
+ {
+ "version": "12.9.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.9.0/"
+ },
+ {
+ "version": "12.8.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.8.0/"
+ },
+ {
+ "version": "12.6.2",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.6.2/"
+ },
+ {
+ "version": "12.6.1",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.6.1/"
+ }
+]
diff --git a/cuda_core/docs/source/_static/javascripts/version_dropdown.js b/cuda_core/docs/source/_static/javascripts/version_dropdown.js
deleted file mode 100644
index 5878c344f1..0000000000
--- a/cuda_core/docs/source/_static/javascripts/version_dropdown.js
+++ /dev/null
@@ -1,61 +0,0 @@
-// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-function change_current_version(event) {
- event.preventDefault();
-
- var selectedVersion = event.target.textContent;
- var currentVersion = document.getElementById('currentVersion');
-
- // need to update both the on-screen state and the internal (persistent) storage
- currentVersion.textContent = selectedVersion;
- sessionStorage.setItem("currentVersion", selectedVersion);
-
- // Navigate to the clicked URL
- window.location.href = event.target.href;
-}
-
-
-function add_version_dropdown(jsonLoc, targetLoc, currentVersion) {
- var otherVersionsDiv = document.getElementById('otherVersions');
-
- fetch(jsonLoc)
- .then(function(response) {
- return response.json();
- })
- .then(function(data) {
- var versions = data;
-
- if (Object.keys(versions).length >= 1) {
- var dlElement = document.createElement('dl');
- var dtElement = document.createElement('dt');
- dtElement.textContent = 'Versions';
- dlElement.appendChild(dtElement);
-
- for (var ver in versions) {
- var url = versions[ver];
- var ddElement = document.createElement('dd');
- var aElement = document.createElement('a');
- aElement.setAttribute('href', targetLoc + url);
- aElement.textContent = ver;
-
- if (ver === currentVersion) {
- var strongElement = document.createElement('strong');
- strongElement.appendChild(aElement);
- aElement = strongElement;
- }
-
- ddElement.appendChild(aElement);
- // Attach event listeners to version links
- ddElement.addEventListener('click', change_current_version);
- dlElement.appendChild(ddElement);
- }
-
- otherVersionsDiv.innerHTML = '';
- otherVersionsDiv.appendChild(dlElement);
- }
- })
- .catch(function(error) {
- console.error('Error fetching version.json:', error);
- });
-}
diff --git a/cuda_core/docs/source/_templates/sidebar/variant-selector.html b/cuda_core/docs/source/_templates/sidebar/variant-selector.html
deleted file mode 100644
index 7110d24a61..0000000000
--- a/cuda_core/docs/source/_templates/sidebar/variant-selector.html
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
- cuda-core
- v: {{ version }}
-
-
-
-
-
-
-
-
-
diff --git a/cuda_core/docs/source/conf.py b/cuda_core/docs/source/conf.py
index fd62db4678..3d5149d3cf 100644
--- a/cuda_core/docs/source/conf.py
+++ b/cuda_core/docs/source/conf.py
@@ -56,27 +56,17 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_baseurl = "docs"
-html_theme = "furo"
-# html_theme = 'pydata_sphinx_theme'
+html_theme = "nvidia_sphinx_theme"
html_theme_options = {
- "light_logo": "logo-light-mode.png",
- "dark_logo": "logo-dark-mode.png",
- # For pydata_sphinx_theme:
- # "logo": {
- # "image_light": "_static/logo-light-mode.png",
- # "image_dark": "_static/logo-dark-mode.png",
- # },
- # "switcher": {
- # "json_url": "https://nvidia.github.io/cuda-python/cuda-core/versions.json",
- # "version_match": release,
- # },
- ## Add light/dark mode and documentation version switcher
- # "navbar_end": [
- # "search-button",
- # "theme-switcher",
- # "version-switcher",
- # "navbar-icon-links",
- # ],
+ "switcher": {
+ "json_url": "https://nvidia.github.io/cuda-python/cuda-core/versions.json",
+ "version_match": release,
+ },
+ # Add light/dark mode and documentation version switcher
+ "navbar_center": [
+ "version-switcher",
+ "navbar-nav",
+ ],
}
if os.environ.get("CI"):
if int(os.environ.get("BUILD_PREVIEW", 0)):
diff --git a/cuda_core/docs/versions.json b/cuda_core/docs/versions.json
index f5e2af0a27..d1c10914cd 100644
--- a/cuda_core/docs/versions.json
+++ b/cuda_core/docs/versions.json
@@ -1,9 +1,30 @@
-{
- "latest" : "latest",
- "0.3.2" : "0.3.2",
- "0.3.1" : "0.3.1",
- "0.3.0" : "0.3.0",
- "0.2.0" : "0.2.0",
- "0.1.1" : "0.1.1",
- "0.1.0" : "0.1.0"
-}
+[
+ {
+ "version": "latest",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/latest/"
+ },
+ {
+ "version": "0.3.2",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.2/"
+ },
+ {
+ "version": "0.3.1",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.1/"
+ },
+ {
+ "version": "0.3.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.0/"
+ },
+ {
+ "version": "0.2.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.2.0/"
+ },
+ {
+ "version": "0.1.1",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.1.1/"
+ },
+ {
+ "version": "0.1.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.1.0/"
+ }
+]
diff --git a/cuda_python/docs/environment-docs.yml b/cuda_python/docs/environment-docs.yml
index a3e10599e0..47f1875e3a 100644
--- a/cuda_python/docs/environment-docs.yml
+++ b/cuda_python/docs/environment-docs.yml
@@ -15,8 +15,9 @@ dependencies:
- scipy
- sphinx <8.2.0
- sphinx-copybutton
- - furo
- myst-nb
- enum_tools
- sphinx-toolbox
- pyclibrary
+ - pip:
+ - nvidia-sphinx-theme
diff --git a/cuda_python/docs/source/_static/javascripts/version_dropdown.js b/cuda_python/docs/source/_static/javascripts/version_dropdown.js
deleted file mode 100644
index 9348d2bf84..0000000000
--- a/cuda_python/docs/source/_static/javascripts/version_dropdown.js
+++ /dev/null
@@ -1,61 +0,0 @@
-// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
-// SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
-
-function change_current_version(event) {
- event.preventDefault();
-
- var selectedVersion = event.target.textContent;
- var currentVersion = document.getElementById('currentVersion');
-
- // need to update both the on-screen state and the internal (persistent) storage
- currentVersion.textContent = selectedVersion;
- sessionStorage.setItem("currentVersion", selectedVersion);
-
- // Navigate to the clicked URL
- window.location.href = event.target.href;
-}
-
-
-function add_version_dropdown(jsonLoc, targetLoc, currentVersion) {
- var otherVersionsDiv = document.getElementById('otherVersions');
-
- fetch(jsonLoc)
- .then(function(response) {
- return response.json();
- })
- .then(function(data) {
- var versions = data;
-
- if (Object.keys(versions).length >= 1) {
- var dlElement = document.createElement('dl');
- var dtElement = document.createElement('dt');
- dtElement.textContent = 'Versions';
- dlElement.appendChild(dtElement);
-
- for (var ver in versions) {
- var url = versions[ver];
- var ddElement = document.createElement('dd');
- var aElement = document.createElement('a');
- aElement.setAttribute('href', targetLoc + url);
- aElement.textContent = ver;
-
- if (ver === currentVersion) {
- var strongElement = document.createElement('strong');
- strongElement.appendChild(aElement);
- aElement = strongElement;
- }
-
- ddElement.appendChild(aElement);
- // Attach event listeners to version links
- ddElement.addEventListener('click', change_current_version);
- dlElement.appendChild(ddElement);
- }
-
- otherVersionsDiv.innerHTML = '';
- otherVersionsDiv.appendChild(dlElement);
- }
- })
- .catch(function(error) {
- console.error('Error fetching version.json:', error);
- });
-}
diff --git a/cuda_python/docs/source/_templates/sidebar/variant-selector.html b/cuda_python/docs/source/_templates/sidebar/variant-selector.html
deleted file mode 100644
index bec47cf474..0000000000
--- a/cuda_python/docs/source/_templates/sidebar/variant-selector.html
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
- cuda-python
- v: {{ version }}
-
-
-
-
-
-
-
-
-
diff --git a/cuda_python/docs/source/conf.py b/cuda_python/docs/source/conf.py
index aae73eb119..41073b9754 100644
--- a/cuda_python/docs/source/conf.py
+++ b/cuda_python/docs/source/conf.py
@@ -52,27 +52,17 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_baseurl = "docs"
-html_theme = "furo"
-# html_theme = 'pydata_sphinx_theme'
+html_theme = "nvidia_sphinx_theme"
html_theme_options = {
- "light_logo": "logo-light-mode.png",
- "dark_logo": "logo-dark-mode.png",
- # For pydata_sphinx_theme:
- # "logo": {
- # "image_light": "_static/logo-light-mode.png",
- # "image_dark": "_static/logo-dark-mode.png",
- # },
- # "switcher": {
- # "json_url": "https://nvidia.github.io/cuda-python/cuda-core/versions.json",
- # "version_match": release,
- # },
- ## Add light/dark mode and documentation version switcher
- # "navbar_end": [
- # "search-button",
- # "theme-switcher",
- # "version-switcher",
- # "navbar-icon-links",
- # ],
+ "switcher": {
+ "json_url": "https://nvidia.github.io/cuda-python/versions.json",
+ "version_match": release,
+ },
+ # Add light/dark mode and documentation version switcher
+ "navbar_center": [
+ "version-switcher",
+ "navbar-nav",
+ ],
}
if os.environ.get("CI"):
if int(os.environ.get("BUILD_PREVIEW", 0)):
diff --git a/cuda_python/docs/versions.json b/cuda_python/docs/versions.json
index 76c66eca88..bb43580397 100644
--- a/cuda_python/docs/versions.json
+++ b/cuda_python/docs/versions.json
@@ -1,9 +1,30 @@
-{
- "latest" : "latest",
- "13.0.1" : "13.0.1",
- "13.0.0" : "13.0.0",
- "12.9.0" : "12.9.0",
- "12.8.0" : "12.8.0",
- "12.6.2" : "12.6.2",
- "12.6.1" : "12.6.1"
-}
+[
+ {
+ "version": "latest",
+ "url": "https://nvidia.github.io/cuda-python/latest/"
+ },
+ {
+ "version": "13.0.1",
+ "url": "https://nvidia.github.io/cuda-python/13.0.1/"
+ },
+ {
+ "version": "13.0.0",
+ "url": "https://nvidia.github.io/cuda-python/13.0.0/"
+ },
+ {
+ "version": "12.9.0",
+ "url": "https://nvidia.github.io/cuda-python/12.9.0/"
+ },
+ {
+ "version": "12.8.0",
+ "url": "https://nvidia.github.io/cuda-python/12.8.0/"
+ },
+ {
+ "version": "12.6.2",
+ "url": "https://nvidia.github.io/cuda-python/12.6.2/"
+ },
+ {
+ "version": "12.6.1",
+ "url": "https://nvidia.github.io/cuda-python/12.6.1/"
+ }
+]
From 1a7c3c4c8db3936931fc597601fa798e2680bea7 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 21 Aug 2025 02:29:13 +0000
Subject: [PATCH 3/8] Temporarily disable test jobs in CI, keeping only wheel
build and doc jobs
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
---
.github/workflows/ci.yml | 102 ++++++++++++++++++++-------------------
1 file changed, 52 insertions(+), 50 deletions(-)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 823be159f4..f5cf68ed5a 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -50,46 +50,47 @@ jobs:
host-platform: ${{ matrix.host-platform }}
cuda-version: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
- test-linux:
- strategy:
- fail-fast: false
- matrix:
- host-platform:
- - linux-64
- - linux-aarch64
- name: Test ${{ matrix.host-platform }}
- if: ${{ github.repository_owner == 'nvidia' }}
- permissions:
- contents: read # This is required for actions/checkout
- needs:
- - ci-vars
- - build
- secrets: inherit
- uses: ./.github/workflows/test-wheel-linux.yml
- with:
- build-type: pull-request
- host-platform: ${{ matrix.host-platform }}
- build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
+ # Temporarily disabled test jobs for documentation theme migration
+ # test-linux:
+ # strategy:
+ # fail-fast: false
+ # matrix:
+ # host-platform:
+ # - linux-64
+ # - linux-aarch64
+ # name: Test ${{ matrix.host-platform }}
+ # if: ${{ github.repository_owner == 'nvidia' }}
+ # permissions:
+ # contents: read # This is required for actions/checkout
+ # needs:
+ # - ci-vars
+ # - build
+ # secrets: inherit
+ # uses: ./.github/workflows/test-wheel-linux.yml
+ # with:
+ # build-type: pull-request
+ # host-platform: ${{ matrix.host-platform }}
+ # build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
- test-windows:
- strategy:
- fail-fast: false
- matrix:
- host-platform:
- - win-64
- name: Test ${{ matrix.host-platform }}
- if: ${{ github.repository_owner == 'nvidia' }}
- permissions:
- contents: read # This is required for actions/checkout
- needs:
- - ci-vars
- - build
- secrets: inherit
- uses: ./.github/workflows/test-wheel-windows.yml
- with:
- build-type: pull-request
- host-platform: ${{ matrix.host-platform }}
- build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
+ # test-windows:
+ # strategy:
+ # fail-fast: false
+ # matrix:
+ # host-platform:
+ # - win-64
+ # name: Test ${{ matrix.host-platform }}
+ # if: ${{ github.repository_owner == 'nvidia' }}
+ # permissions:
+ # contents: read # This is required for actions/checkout
+ # needs:
+ # - ci-vars
+ # - build
+ # secrets: inherit
+ # uses: ./.github/workflows/test-wheel-windows.yml
+ # with:
+ # build-type: pull-request
+ # host-platform: ${{ matrix.host-platform }}
+ # build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
doc:
name: Docs
@@ -107,14 +108,15 @@ jobs:
with:
build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
- checks:
- name: Check job status
- permissions:
- checks: read
- needs:
- - build
- - test-linux
- - test-windows
- - doc
- secrets: inherit
- uses: ./.github/workflows/status-check.yml
+ # Temporarily disabled status check job as it depends on test jobs
+ # checks:
+ # name: Check job status
+ # permissions:
+ # checks: read
+ # needs:
+ # - build
+ # - test-linux
+ # - test-windows
+ # - doc
+ # secrets: inherit
+ # uses: ./.github/workflows/status-check.yml
From 76399c914e19fdad653412d08651a6d87b2aa5a2 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 21 Aug 2025 02:57:18 +0000
Subject: [PATCH 4/8] Address PR feedback: Fix CI workflow and preserve
original versions.json files
- Modify CI workflow to only comment out test-linux/test-windows in needs section instead of entire status check job
- Revert all versions.json files to original format for backward compatibility
- Create new nv-versions.json files with new format for nvidia-sphinx-theme
- Update sphinx config files to reference new nv-versions.json files
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
---
.github/workflows/ci.yml | 23 ++++++++---------
cuda_bindings/docs/nv-versions.json | 30 ++++++++++++++++++++++
cuda_bindings/docs/source/conf.py | 2 +-
cuda_bindings/docs/versions.json | 39 +++++++----------------------
cuda_core/docs/nv-versions.json | 30 ++++++++++++++++++++++
cuda_core/docs/source/conf.py | 2 +-
cuda_core/docs/versions.json | 39 +++++++----------------------
cuda_python/docs/nv-versions.json | 30 ++++++++++++++++++++++
cuda_python/docs/source/conf.py | 2 +-
cuda_python/docs/versions.json | 39 +++++++----------------------
10 files changed, 131 insertions(+), 105 deletions(-)
create mode 100644 cuda_bindings/docs/nv-versions.json
create mode 100644 cuda_core/docs/nv-versions.json
create mode 100644 cuda_python/docs/nv-versions.json
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index f5cf68ed5a..0b1f2f076d 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -108,15 +108,14 @@ jobs:
with:
build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
- # Temporarily disabled status check job as it depends on test jobs
- # checks:
- # name: Check job status
- # permissions:
- # checks: read
- # needs:
- # - build
- # - test-linux
- # - test-windows
- # - doc
- # secrets: inherit
- # uses: ./.github/workflows/status-check.yml
+ checks:
+ name: Check job status
+ permissions:
+ checks: read
+ needs:
+ - build
+ # - test-linux # Temporarily disabled for documentation theme migration
+ # - test-windows # Temporarily disabled for documentation theme migration
+ - doc
+ secrets: inherit
+ uses: ./.github/workflows/status-check.yml
diff --git a/cuda_bindings/docs/nv-versions.json b/cuda_bindings/docs/nv-versions.json
new file mode 100644
index 0000000000..0031e6238a
--- /dev/null
+++ b/cuda_bindings/docs/nv-versions.json
@@ -0,0 +1,30 @@
+[
+ {
+ "version": "latest",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/latest/"
+ },
+ {
+ "version": "13.0.1",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/13.0.1/"
+ },
+ {
+ "version": "13.0.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/13.0.0/"
+ },
+ {
+ "version": "12.9.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.9.0/"
+ },
+ {
+ "version": "12.8.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.8.0/"
+ },
+ {
+ "version": "12.6.2",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.6.2/"
+ },
+ {
+ "version": "12.6.1",
+ "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.6.1/"
+ }
+]
diff --git a/cuda_bindings/docs/source/conf.py b/cuda_bindings/docs/source/conf.py
index 8c8673a001..93427d3631 100644
--- a/cuda_bindings/docs/source/conf.py
+++ b/cuda_bindings/docs/source/conf.py
@@ -62,7 +62,7 @@
html_theme = "nvidia_sphinx_theme"
html_theme_options = {
"switcher": {
- "json_url": "https://nvidia.github.io/cuda-python/cuda-bindings/versions.json",
+ "json_url": "https://nvidia.github.io/cuda-python/cuda-bindings/nv-versions.json",
"version_match": release,
},
# Add light/dark mode and documentation version switcher
diff --git a/cuda_bindings/docs/versions.json b/cuda_bindings/docs/versions.json
index 0031e6238a..76c66eca88 100644
--- a/cuda_bindings/docs/versions.json
+++ b/cuda_bindings/docs/versions.json
@@ -1,30 +1,9 @@
-[
- {
- "version": "latest",
- "url": "https://nvidia.github.io/cuda-python/cuda-bindings/latest/"
- },
- {
- "version": "13.0.1",
- "url": "https://nvidia.github.io/cuda-python/cuda-bindings/13.0.1/"
- },
- {
- "version": "13.0.0",
- "url": "https://nvidia.github.io/cuda-python/cuda-bindings/13.0.0/"
- },
- {
- "version": "12.9.0",
- "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.9.0/"
- },
- {
- "version": "12.8.0",
- "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.8.0/"
- },
- {
- "version": "12.6.2",
- "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.6.2/"
- },
- {
- "version": "12.6.1",
- "url": "https://nvidia.github.io/cuda-python/cuda-bindings/12.6.1/"
- }
-]
+{
+ "latest" : "latest",
+ "13.0.1" : "13.0.1",
+ "13.0.0" : "13.0.0",
+ "12.9.0" : "12.9.0",
+ "12.8.0" : "12.8.0",
+ "12.6.2" : "12.6.2",
+ "12.6.1" : "12.6.1"
+}
diff --git a/cuda_core/docs/nv-versions.json b/cuda_core/docs/nv-versions.json
new file mode 100644
index 0000000000..d1c10914cd
--- /dev/null
+++ b/cuda_core/docs/nv-versions.json
@@ -0,0 +1,30 @@
+[
+ {
+ "version": "latest",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/latest/"
+ },
+ {
+ "version": "0.3.2",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.2/"
+ },
+ {
+ "version": "0.3.1",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.1/"
+ },
+ {
+ "version": "0.3.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.0/"
+ },
+ {
+ "version": "0.2.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.2.0/"
+ },
+ {
+ "version": "0.1.1",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.1.1/"
+ },
+ {
+ "version": "0.1.0",
+ "url": "https://nvidia.github.io/cuda-python/cuda-core/0.1.0/"
+ }
+]
diff --git a/cuda_core/docs/source/conf.py b/cuda_core/docs/source/conf.py
index 3d5149d3cf..c172d0995f 100644
--- a/cuda_core/docs/source/conf.py
+++ b/cuda_core/docs/source/conf.py
@@ -59,7 +59,7 @@
html_theme = "nvidia_sphinx_theme"
html_theme_options = {
"switcher": {
- "json_url": "https://nvidia.github.io/cuda-python/cuda-core/versions.json",
+ "json_url": "https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json",
"version_match": release,
},
# Add light/dark mode and documentation version switcher
diff --git a/cuda_core/docs/versions.json b/cuda_core/docs/versions.json
index d1c10914cd..f5e2af0a27 100644
--- a/cuda_core/docs/versions.json
+++ b/cuda_core/docs/versions.json
@@ -1,30 +1,9 @@
-[
- {
- "version": "latest",
- "url": "https://nvidia.github.io/cuda-python/cuda-core/latest/"
- },
- {
- "version": "0.3.2",
- "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.2/"
- },
- {
- "version": "0.3.1",
- "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.1/"
- },
- {
- "version": "0.3.0",
- "url": "https://nvidia.github.io/cuda-python/cuda-core/0.3.0/"
- },
- {
- "version": "0.2.0",
- "url": "https://nvidia.github.io/cuda-python/cuda-core/0.2.0/"
- },
- {
- "version": "0.1.1",
- "url": "https://nvidia.github.io/cuda-python/cuda-core/0.1.1/"
- },
- {
- "version": "0.1.0",
- "url": "https://nvidia.github.io/cuda-python/cuda-core/0.1.0/"
- }
-]
+{
+ "latest" : "latest",
+ "0.3.2" : "0.3.2",
+ "0.3.1" : "0.3.1",
+ "0.3.0" : "0.3.0",
+ "0.2.0" : "0.2.0",
+ "0.1.1" : "0.1.1",
+ "0.1.0" : "0.1.0"
+}
diff --git a/cuda_python/docs/nv-versions.json b/cuda_python/docs/nv-versions.json
new file mode 100644
index 0000000000..bb43580397
--- /dev/null
+++ b/cuda_python/docs/nv-versions.json
@@ -0,0 +1,30 @@
+[
+ {
+ "version": "latest",
+ "url": "https://nvidia.github.io/cuda-python/latest/"
+ },
+ {
+ "version": "13.0.1",
+ "url": "https://nvidia.github.io/cuda-python/13.0.1/"
+ },
+ {
+ "version": "13.0.0",
+ "url": "https://nvidia.github.io/cuda-python/13.0.0/"
+ },
+ {
+ "version": "12.9.0",
+ "url": "https://nvidia.github.io/cuda-python/12.9.0/"
+ },
+ {
+ "version": "12.8.0",
+ "url": "https://nvidia.github.io/cuda-python/12.8.0/"
+ },
+ {
+ "version": "12.6.2",
+ "url": "https://nvidia.github.io/cuda-python/12.6.2/"
+ },
+ {
+ "version": "12.6.1",
+ "url": "https://nvidia.github.io/cuda-python/12.6.1/"
+ }
+]
diff --git a/cuda_python/docs/source/conf.py b/cuda_python/docs/source/conf.py
index 41073b9754..9bd3dcc78c 100644
--- a/cuda_python/docs/source/conf.py
+++ b/cuda_python/docs/source/conf.py
@@ -55,7 +55,7 @@
html_theme = "nvidia_sphinx_theme"
html_theme_options = {
"switcher": {
- "json_url": "https://nvidia.github.io/cuda-python/versions.json",
+ "json_url": "https://nvidia.github.io/cuda-python/nv-versions.json",
"version_match": release,
},
# Add light/dark mode and documentation version switcher
diff --git a/cuda_python/docs/versions.json b/cuda_python/docs/versions.json
index bb43580397..76c66eca88 100644
--- a/cuda_python/docs/versions.json
+++ b/cuda_python/docs/versions.json
@@ -1,30 +1,9 @@
-[
- {
- "version": "latest",
- "url": "https://nvidia.github.io/cuda-python/latest/"
- },
- {
- "version": "13.0.1",
- "url": "https://nvidia.github.io/cuda-python/13.0.1/"
- },
- {
- "version": "13.0.0",
- "url": "https://nvidia.github.io/cuda-python/13.0.0/"
- },
- {
- "version": "12.9.0",
- "url": "https://nvidia.github.io/cuda-python/12.9.0/"
- },
- {
- "version": "12.8.0",
- "url": "https://nvidia.github.io/cuda-python/12.8.0/"
- },
- {
- "version": "12.6.2",
- "url": "https://nvidia.github.io/cuda-python/12.6.2/"
- },
- {
- "version": "12.6.1",
- "url": "https://nvidia.github.io/cuda-python/12.6.1/"
- }
-]
+{
+ "latest" : "latest",
+ "13.0.1" : "13.0.1",
+ "13.0.0" : "13.0.0",
+ "12.9.0" : "12.9.0",
+ "12.8.0" : "12.8.0",
+ "12.6.2" : "12.6.2",
+ "12.6.1" : "12.6.1"
+}
From c72a6b2bba269a282d43abf4bec71743564f9395 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 21 Aug 2025 03:30:16 +0000
Subject: [PATCH 5/8] Fix sphinx version constraint to resolve
nvidia-sphinx-theme CI failure
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
---
cuda_python/docs/environment-docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/cuda_python/docs/environment-docs.yml b/cuda_python/docs/environment-docs.yml
index 47f1875e3a..0d10acca29 100644
--- a/cuda_python/docs/environment-docs.yml
+++ b/cuda_python/docs/environment-docs.yml
@@ -13,7 +13,7 @@ dependencies:
- pydata-sphinx-theme
- pytest
- scipy
- - sphinx <8.2.0
+ - sphinx >=7.1,<9.0
- sphinx-copybutton
- myst-nb
- enum_tools
From 464e3b8eaf101080d0784252a61221590a2bb75c Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 21 Aug 2025 13:15:51 +0000
Subject: [PATCH 6/8] Revert sphinx version constraint changes from commit
c72a6b2
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
---
cuda_python/docs/environment-docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/cuda_python/docs/environment-docs.yml b/cuda_python/docs/environment-docs.yml
index 0d10acca29..47f1875e3a 100644
--- a/cuda_python/docs/environment-docs.yml
+++ b/cuda_python/docs/environment-docs.yml
@@ -13,7 +13,7 @@ dependencies:
- pydata-sphinx-theme
- pytest
- scipy
- - sphinx >=7.1,<9.0
+ - sphinx <8.2.0
- sphinx-copybutton
- myst-nb
- enum_tools
From 32e30f4b781e5f37bfb764d64b1d98caa26b9cee Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 21 Aug 2025 13:54:52 +0000
Subject: [PATCH 7/8] Comment out proxy cache in docs build to debug
nvidia-sphinx-theme installation
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
---
.github/workflows/build-docs.yml | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index 0e8af64cbb..d188b3a480 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -52,9 +52,10 @@ jobs:
fetch-depth: 0
ref: ${{ inputs.git-tag }}
- - name: Setup proxy cache
- uses: nv-gha-runners/setup-proxy-cache@main
- continue-on-error: true
+ # Temporarily disabled to debug nvidia-sphinx-theme installation issues
+ # - name: Setup proxy cache
+ # uses: nv-gha-runners/setup-proxy-cache@main
+ # continue-on-error: true
- name: Set up miniforge
uses: conda-incubator/setup-miniconda@835234971496cad1653abb28a638a281cf32541f # v3.2.0
From 56bd1c369572a69c67b8609aeb5f70ee8fe08777 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 21 Aug 2025 15:31:40 +0000
Subject: [PATCH 8/8] Revert ci.yml changes and remove proxy cache from
build-docs.yml
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
---
.github/workflows/build-docs.yml | 5 +-
.github/workflows/ci.yml | 83 ++++++++++++++++----------------
2 files changed, 42 insertions(+), 46 deletions(-)
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index d188b3a480..ed58b4f260 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -52,10 +52,7 @@ jobs:
fetch-depth: 0
ref: ${{ inputs.git-tag }}
- # Temporarily disabled to debug nvidia-sphinx-theme installation issues
- # - name: Setup proxy cache
- # uses: nv-gha-runners/setup-proxy-cache@main
- # continue-on-error: true
+ # TODO: This workflow runs on GH-hosted runner and cannot use the proxy cache
- name: Set up miniforge
uses: conda-incubator/setup-miniconda@835234971496cad1653abb28a638a281cf32541f # v3.2.0
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 0b1f2f076d..823be159f4 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -50,47 +50,46 @@ jobs:
host-platform: ${{ matrix.host-platform }}
cuda-version: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
- # Temporarily disabled test jobs for documentation theme migration
- # test-linux:
- # strategy:
- # fail-fast: false
- # matrix:
- # host-platform:
- # - linux-64
- # - linux-aarch64
- # name: Test ${{ matrix.host-platform }}
- # if: ${{ github.repository_owner == 'nvidia' }}
- # permissions:
- # contents: read # This is required for actions/checkout
- # needs:
- # - ci-vars
- # - build
- # secrets: inherit
- # uses: ./.github/workflows/test-wheel-linux.yml
- # with:
- # build-type: pull-request
- # host-platform: ${{ matrix.host-platform }}
- # build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
+ test-linux:
+ strategy:
+ fail-fast: false
+ matrix:
+ host-platform:
+ - linux-64
+ - linux-aarch64
+ name: Test ${{ matrix.host-platform }}
+ if: ${{ github.repository_owner == 'nvidia' }}
+ permissions:
+ contents: read # This is required for actions/checkout
+ needs:
+ - ci-vars
+ - build
+ secrets: inherit
+ uses: ./.github/workflows/test-wheel-linux.yml
+ with:
+ build-type: pull-request
+ host-platform: ${{ matrix.host-platform }}
+ build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
- # test-windows:
- # strategy:
- # fail-fast: false
- # matrix:
- # host-platform:
- # - win-64
- # name: Test ${{ matrix.host-platform }}
- # if: ${{ github.repository_owner == 'nvidia' }}
- # permissions:
- # contents: read # This is required for actions/checkout
- # needs:
- # - ci-vars
- # - build
- # secrets: inherit
- # uses: ./.github/workflows/test-wheel-windows.yml
- # with:
- # build-type: pull-request
- # host-platform: ${{ matrix.host-platform }}
- # build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
+ test-windows:
+ strategy:
+ fail-fast: false
+ matrix:
+ host-platform:
+ - win-64
+ name: Test ${{ matrix.host-platform }}
+ if: ${{ github.repository_owner == 'nvidia' }}
+ permissions:
+ contents: read # This is required for actions/checkout
+ needs:
+ - ci-vars
+ - build
+ secrets: inherit
+ uses: ./.github/workflows/test-wheel-windows.yml
+ with:
+ build-type: pull-request
+ host-platform: ${{ matrix.host-platform }}
+ build-ctk-ver: ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
doc:
name: Docs
@@ -114,8 +113,8 @@ jobs:
checks: read
needs:
- build
- # - test-linux # Temporarily disabled for documentation theme migration
- # - test-windows # Temporarily disabled for documentation theme migration
+ - test-linux
+ - test-windows
- doc
secrets: inherit
uses: ./.github/workflows/status-check.yml