Skip to content

Publish versioned docs to docs.nvidia.com with a version switcher - #754

Merged
ncclementi merged 6 commits into
rapidsai:mainfrom
jayavenkatesh19:docs-nvidia-version-switcher
Sep 9, 2026
Merged

Publish versioned docs to docs.nvidia.com with a version switcher#754
ncclementi merged 6 commits into
rapidsai:mainfrom
jayavenkatesh19:docs-nvidia-version-switcher

Conversation

@jayavenkatesh19

@jayavenkatesh19 jayavenkatesh19 commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Addition to #722

This PR is intended to move publishing docs away from stable/nightly versioning and onto the latest/YY.MM versioning scheme.

  • Pushes to main publish to datascience/deployment/latest
  • vYY.MM.PP tags publish to datascience/deployment/YY.MM (alpha tags do not publish)
  • A version.json is published next to those directories which enables the navbar version switcher.

Both uploads go through the publish-docs and publish-one-doc shared actions. The workflow itself has no logic in it, the Sphinx build writes a small ephemeral manifest at build/publish/publish.env which specifies where the files have to be published to which is picked up by the workflow.

The version.json is created from a new Sphinx extension called rapids_docs_publishing. It runs only when the workflow sets RAPIDS_DOCS_PUBLISH=true, so local and ReadTheDocs builds do have show any switcher on the builds.

This PR also stops publishing to the old rapidsai-docs bucket and we will setup redirects on rapidsai/docs to redirect all links from docs.rapids.ai/deployment/* to docs.nvidia.com/datascience/deployment/*

Can only be merged after rapidsai/shared-actions#142 is merged. [EDIT: This has been merged]

@jayavenkatesh19
jayavenkatesh19 requested a review from a team as a code owner September 8, 2026 22:34
@jayavenkatesh19
jayavenkatesh19 marked this pull request as draft September 8, 2026 23:21
@jayavenkatesh19 jayavenkatesh19 changed the title Publish versioned docs to docs.nvidia.com with a version switcher [WIP] Publish versioned docs to docs.nvidia.com with a version switcher Sep 8, 2026
@jayavenkatesh19 jayavenkatesh19 self-assigned this Sep 8, 2026
- name: Set version
id: set-version
run: echo "VERSION=${{ startsWith(github.event.ref, 'refs/tags/') && 'stable' || 'nightly' }}" >> "$GITHUB_OUTPUT"
run: RAPIDS_DOCS_RELEASE_TAGS="$(git tag --list)" uv run make dirhtml SPHINXOPTS="-W --keep-going -n"

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.

Just checking did we end up pushing to the rapids S3? are we ready to stop publishing the rapids docs?

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.

As soon as we get something on docs.nvidia.com we can stop publishing to docs.rapids.ai and add redirects.

@ncclementi

Copy link
Copy Markdown
Contributor

Just to check, in the current read the docs generated in CI we do have in the nav bar the dev tag. I'm not sure if we want to keep that or if we don't care.

Screenshot 2026-09-09 at 11 31 59 AM

@ncclementi
ncclementi marked this pull request as ready for review September 9, 2026 15:36

@bdice bdice 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.

Approving with very light review since this has to be merged to be tested.

@jayavenkatesh19 jayavenkatesh19 changed the title [WIP] Publish versioned docs to docs.nvidia.com with a version switcher Publish versioned docs to docs.nvidia.com with a version switcher Sep 9, 2026
@jayavenkatesh19

jayavenkatesh19 commented Sep 9, 2026

Copy link
Copy Markdown
Contributor Author

Answering @ncclementi's question, we will now not have a switcher on local/ReadTheDocs builds.

We previously had a switcher which was defined in a HTML file (see the older approach in PR changes), but the new NVIDIA theme has the option to enable the switcher only when a versions.json file is present in the build directory. We create that file in the new Sphinx extension added by the PR, and push it to the S3 bucket so that the docs.nvidia.com site does have the switcher.

@ncclementi ncclementi 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.

Let's merge this and see what happens, as we'll need to iterate

@ncclementi
ncclementi merged commit 5f8ad7b into rapidsai:main Sep 9, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants