Skip to content

Publishing updates - #3399

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

Publishing updates#3399
zredeaux07 wants to merge 16 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 stack to NVIDIA’s Sphinx theme and adds release notes and version-switching support.

  • Installs the NVIDIA theme, MyST parser, and compatible theme dependencies in documentation CI.
  • Configures Markdown sources, the corrected Transformer Engine repository link, and a published version-switcher manifest.
  • Adds initial release notes and a documentation archive while removing obsolete RTD-theme customizations.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
.github/workflows/docs.yml Documentation CI now installs the theme and Markdown dependencies required by the updated Sphinx configuration.
docs/conf.py The theme import, repository link, switcher manifest, and source-suffix configuration now align with the files and dependencies in the PR.
docs/index.rst The release-notes toctree entry now resolves to the added Markdown document.
docs/versions1.json The checked-in switcher manifest satisfies the sole html_extra_path entry and defines current and archived documentation destinations.
docs/release_notes.md Adds the initial Markdown release-notes page consumed by the updated toctree.

Reviews (7): Last reviewed commit: "Merge branch 'NVIDIA:main' into zredeaux..." | 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
@zredeaux07
zredeaux07 marked this pull request as ready for review August 25, 2026 19:15
@ksivaman

Copy link
Copy Markdown
Member

@zredeaux07 Thanks for making the review changes! The generated docs look good to me. @mckimn please take a look at the artifacts.

@zredeaux07 Could you sign-off all your commits to pass the DCO check? Thanks!

@zredeaux07 zredeaux07 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

signed off on comments.

Comment thread docs/release_notes.rst Outdated
Comment thread docs/index.rst Outdated
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