Skip to content

Switch to nvidia-sphinx-theme with backward-compatible version switching#874

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

Merged
leofang merged 8 commits into from
Aug 21, 2025
Merged

Switch to nvidia-sphinx-theme with backward-compatible version switching #874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e7ee8f0
Initial plan
Copilot Aug 21, 2025
6b88372
Switch to nvidia-sphinx-theme and update version JSON format
Copilot Aug 21, 2025
1a7c3c4
Temporarily disable test jobs in CI, keeping only wheel build and doc…
Copilot Aug 21, 2025
76399c9
Address PR feedback: Fix CI workflow and preserve original versions.j…
Copilot Aug 21, 2025
c72a6b2
Fix sphinx version constraint to resolve nvidia-sphinx-theme CI failure
Copilot Aug 21, 2025
464e3b8
Revert sphinx version constraint changes from commit c72a6b2
Copilot Aug 21, 2025
32e30f4
Comment out proxy cache in docs build to debug nvidia-sphinx-theme in…
Copilot Aug 21, 2025
56bd1c3
Revert ci.yml changes and remove proxy cache from build-docs.yml
Copilot Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/workflows/build-docs.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,9 +52,7 @@ jobs:
fetch-depth: 0
ref: ${{ inputs.git-tag }}

- 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
Expand Down
30 changes: 30 additions & 0 deletions cuda_bindings/docs/nv-versions.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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/"
}
]
61 changes: 0 additions & 61 deletions cuda_bindings/docs/source/_static/javascripts/version_dropdown.js
View file
Open in desktop

This file was deleted.

24 changes: 0 additions & 24 deletions cuda_bindings/docs/source/_templates/sidebar/variant-selector.html
View file
Open in desktop

This file was deleted.

30 changes: 10 additions & 20 deletions cuda_bindings/docs/source/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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/nv-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)):
Expand Down
30 changes: 30 additions & 0 deletions cuda_core/docs/nv-versions.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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/"
}
]
61 changes: 0 additions & 61 deletions cuda_core/docs/source/_static/javascripts/version_dropdown.js
View file
Open in desktop

This file was deleted.

24 changes: 0 additions & 24 deletions cuda_core/docs/source/_templates/sidebar/variant-selector.html
View file
Open in desktop

This file was deleted.

30 changes: 10 additions & 20 deletions cuda_core/docs/source/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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/nv-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)):
Expand Down
3 changes: 2 additions & 1 deletion cuda_python/docs/environment-docs.yml
View file
Open in desktop

@kkraus14kkraus14Aug 21, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Do we still need the pydata-sphinx-theme here?

@leofangleofangAug 21, 2025

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.

yeah for some reason copilot ignored my ask 🤔

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ dependencies:
- scipy
- sphinx <8.2.0
- sphinx-copybutton
- furo
- myst-nb
- enum_tools
- sphinx-toolbox
- pyclibrary
- pip:
- nvidia-sphinx-theme
30 changes: 30 additions & 0 deletions cuda_python/docs/nv-versions.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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/"
}
]
Loading
Loading