Skip to content

Fix GH action generated docs - #3449

Merged
ptrendx merged 1 commit into
NVIDIA:mainfrom
ksivaman:fix_preview_documentation
Aug 31, 2026
Merged

Fix GH action generated docs#3449
ptrendx merged 1 commit into
NVIDIA:mainfrom
ksivaman:fix_preview_documentation

Conversation

@ksivaman

Copy link
Copy Markdown
Member

Description

Issue introduced in #3399, where public_docs_features in the new theme makes the cookies not save on non docs.nvidia.com domains, resulting in continuous pop-up.

Type of change

  • Documentation change (change only to the documentation, either a fix or a new content)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Infra/Build change
  • Code refactoring

Changes

  • Switch public_docs_features off via envvar, and set this envvar in GH actions for a clean preview.

Checklist:

  • I have read and followed the contributing guidelines
  • The functionality is complete
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Signed-off-by: Kirthi Shankar Sivamani <ksivamani@nvidia.com>
@ksivaman
ksivaman requested a review from ptrendx August 31, 2026 21:54
@ksivaman ksivaman added the 2.19 label Aug 31, 2026
@greptile-apps

greptile-apps Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR makes the NVIDIA Sphinx theme’s public-site integrations configurable and disables them for GitHub Actions documentation builds, preventing persistent cookie prompts on non-docs.nvidia.com deployments.

  • Adds NVTE_DOCS_DISABLE_PUBLIC_FEATURES=1 to the documentation build workflow.
  • Defaults public features to enabled while allowing CI-hosted documentation builds to disable them.

Confidence Score: 5/5

The PR appears safe to merge with no actionable correctness or security issues identified.

The workflow supplies the disabling value only for GitHub-hosted documentation builds, while other builds retain the previous enabled default, matching the domain-specific cookie behavior described by the change.

Important Files Changed

Filename Overview
.github/workflows/docs.yml Disables public documentation theme features for GitHub-hosted builds, including previews and the nightly GitHub Pages deployment.
docs/conf.py Converts the new environment variable into the boolean theme option while preserving enabled behavior by default.

Reviews (1): Last reviewed commit: "Fix GH docs" | Re-trigger Greptile

@ptrendx
ptrendx merged commit 82853f1 into NVIDIA:main Aug 31, 2026
12 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants