Skip to content

Publishing updates - #3399

Open
zredeaux07 wants to merge 14 commits into
NVIDIA:mainfrom
zredeaux07:zredeaux07-publishing
Open

Publishing updates#3399
zredeaux07 wants to merge 14 commits into
NVIDIA:mainfrom
zredeaux07:zredeaux07-publishing

Conversation

@zredeaux07

Copy link
Copy Markdown

Made the following changes:

  • Updated Sphinx HTML theme and options
  • Added initial release notes
  • Added release notes to documentation

Changed HTML theme from 'sphinx_rtd_theme' to 'nvidia_sphinx_theme' and updated theme options.

Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
@zredeaux07
zredeaux07 marked this pull request as draft August 18, 2026 21:05
@greptile-apps

greptile-apps Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR updates the documentation publishing configuration to use NVIDIA’s Sphinx theme and adds initial release and archive content.

  • Installs the new theme and Markdown documentation dependencies in CI.
  • Configures the version switcher, Transformer Engine repository link, and static theme assets.
  • Adds Markdown release notes, an archive page, and version-switcher metadata.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
.github/workflows/docs.yml Installs the NVIDIA theme and MyST dependencies before running the warning-as-error Sphinx build.
docs/conf.py Configures the NVIDIA theme, Markdown parsing, version switcher, repository link, and existing extra-path metadata.
docs/index.rst Adds the existing Markdown release-notes document to the Getting Started toctree.
docs/release_notes.md Adds the initial release-notes template consumed through MyST.
docs/versions1.json Defines switcher entries for the latest documentation and release archive.

Reviews (5): Last reviewed commit: "Add copyright to documentation-archive.r..." | Re-trigger Greptile

Comment thread docs/conf.py
Comment thread docs/index.rst Outdated
Comment thread docs/conf.py Outdated
Comment thread docs/conf.py Outdated
@github-actions github-actions Bot added the community-contribution PRs from external contributor outside the core maintainers, representing community-driven work. label Aug 18, 2026
zredeaux07 and others added 3 commits August 18, 2026 14:09
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
Giving the file an extension.

Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
Comment thread docs/conf.py
Comment thread docs/release_notes.rst Outdated
Comment thread docs/conf.py Outdated
Comment thread docs/index.rst Outdated
Comment thread docs/conf.py Outdated
Comment thread docs/conf.py
Comment thread docs/release_notes.rst Outdated
zredeaux07 and others added 2 commits August 19, 2026 10:38
Co-authored-by: mckimn <nmckimpson@nvidia.com>
Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
Co-authored-by: mckimn <nmckimpson@nvidia.com>
Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
@ksivaman
ksivaman requested a review from fheinecke August 19, 2026 20:25
@ksivaman ksivaman added 2.19 and removed community-contribution PRs from external contributor outside the core maintainers, representing community-driven work. labels Aug 19, 2026
@github-actions github-actions Bot added the community-contribution PRs from external contributor outside the core maintainers, representing community-driven work. label Aug 25, 2026
Comment thread docs/conf.py Outdated
"autoapi.extension",
"sphinx_tabs.tabs",
"myst_parser",
"nvidia-sphinx-theme",

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.

P1 Theme extension name cannot import

When CI, nightly publishing, or a local Sphinx build loads this configuration, Sphinx attempts to import the hyphenated nvidia-sphinx-theme extension name and aborts before generating HTML. The documentation environment also does not install the newly selected theme, so the attempted fix leaves the unavailable-theme build failure in place.

@zredeaux07
zredeaux07 marked this pull request as ready for review August 25, 2026 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2.19 community-contribution PRs from external contributor outside the core maintainers, representing community-driven work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants