Skip to content

Refactor docs deployment to support future versioned docs - #5787

Merged
jrhemstad merged 9 commits into
NVIDIA:mainfrom
jrhemstad:fix/docs-preview-cleanup-permissions
Feb 16, 2026
Merged

jrhemstad merged 9 commits into
NVIDIA:mainfrom
jrhemstad:fix/docs-preview-cleanup-permissions

Conversation

@jrhemstad

@jrhemstad jrhemstad commented Sep 5, 2025 •

Copy link
Copy Markdown
Collaborator

This PR updates the docs build/deploy flow so Sphinx emits versioned output and the version switcher resolves correctly on forks and GitHub Pages.

As a result, the docs built from main will be published under https://nvidia.github.io/cccl/unstable and future builds from release branches will be under https://nvidia.github.io/cccl/X.Y.

Key changes

  • docs/gen_docs.bash now reorganizes the Sphinx build into a versioned directory, and writes root assets (index.html redirect, nv-versions.json, versions.json, .nojekyll, and objects.inv) driven by SPHINX_CCCL_VER, CCCL_DOCS_BASE_URL, and CCCL_DOCS_IS_LATEST.
  • docs/conf.py derives the release version from SPHINX_CCCL_VER (fallbacks to VERSION.md/unstable) and configures the theme switcher to fetch nv-versions.json from html_baseurl, which is set via CCCL_DOCS_BASE_URL.
  • docs-deploy.yml computes the base URL from the repo owner/name plus the Pages prefix, derives the deployment destination and latest flag, passes those into the docs build, and deploys under deploy/<publish_prefix> while preserving existing versions with keep_files + force_orphan.

Example versioned docs on my fork: https://jrhemstad.github.io/cccl/unstable/

@jrhemstad
jrhemstad requested review from a team as code owners September 5, 2025 18:09
@github-project-automation github-project-automation Bot moved this to Todo in CCCL Sep 5, 2025
@cccl-authenticator-app cccl-authenticator-app Bot moved this from Todo to In Review in CCCL Sep 5, 2025
@github-actions

github-actions Bot commented Sep 5, 2025

Copy link
Copy Markdown
Contributor

🥳 CI Workflow Results

🟩 Finished in 1h 47m: Pass: 100%/223 | Total: 2d 07h | Max: 1h 29m | Hits: 97%/324647

See results here.

@jrhemstad
jrhemstad force-pushed the fix/docs-preview-cleanup-permissions branch from 24ce067 to cddd168 Compare November 19, 2025 03:11
@copy-pr-bot

copy-pr-bot Bot commented Nov 19, 2025

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.

@jrhemstad
jrhemstad force-pushed the fix/docs-preview-cleanup-permissions branch 6 times, most recently from 4bd89b0 to 3536980 Compare November 20, 2025 20:39
@jrhemstad
jrhemstad force-pushed the fix/docs-preview-cleanup-permissions branch from 3536980 to 30a87d9 Compare November 20, 2025 21:37
@alliepiper alliepiper moved this from In Review to Paused in CCCL Jan 16, 2026
@NVIDIA NVIDIA deleted a comment from github-actions Bot Feb 4, 2026
@jrhemstad

Copy link
Copy Markdown
Collaborator Author

@alliepiper would you mind giving this another review? It's changed quite a bit since your last review.

@jrhemstad
jrhemstad requested a review from alliepiper February 13, 2026 02:22
@wence- wence- mentioned this pull request Feb 13, 2026
2 tasks done

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

This'll be a nice improvement!

@github-project-automation github-project-automation Bot moved this from Paused to In Review in CCCL Feb 16, 2026
@jrhemstad
jrhemstad merged commit 139f952 into NVIDIA:main Feb 16, 2026
4 checks passed
@github-project-automation github-project-automation Bot moved this from In Review to Done in CCCL Feb 16, 2026
@jrhemstad jrhemstad linked an issue Feb 16, 2026 that may be closed by this pull request
fbusato pushed a commit to fbusato/cccl that referenced this pull request Feb 19, 2026
* docs: simplify docs deployment workflow

* Align docs build pipeline with cuda-python layout

* Update docs deployment workflow to include '/docs/' in base URL and disable file retention

* Fix base URL in docs deployment workflow by removing '/docs/' suffix

* Update version metadata format in documentation generation script to use an array instead of an object

* Remove version switcher from the navbar in documentation configuration

* Update GitHub Actions workflow to enable file retention and orphan branch publishing for documentation deployment

* Remove legacy docs version file
fbusato pushed a commit to fbusato/cccl that referenced this pull request Feb 26, 2026
* docs: simplify docs deployment workflow

* Align docs build pipeline with cuda-python layout

* Update docs deployment workflow to include '/docs/' in base URL and disable file retention

* Fix base URL in docs deployment workflow by removing '/docs/' suffix

* Update version metadata format in documentation generation script to use an array instead of an object

* Remove version switcher from the navbar in documentation configuration

* Update GitHub Actions workflow to enable file retention and orphan branch publishing for documentation deployment

* Remove legacy docs version file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Refactor docs deployment to deploy docs from main to unstable

3 participants