Skip to content

Publishing updates - #3399

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

Publishing updates#3399
zredeaux07 wants to merge 20 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 setup and resolves the previously reported build-configuration problems.

  • Migrates documentation from the Read the Docs theme to NVIDIA’s Sphinx theme.
  • Adds a version switcher, documentation archive, and initial release-notes page.
  • Updates documentation CI with the required theme and Markdown dependencies.

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, PyData theme, and MyST parser required by the updated Sphinx configuration.
docs/conf.py Configures the NVIDIA theme, Markdown sources, version switcher, repository link, and existing extra-path asset.
docs/index.rst Adds the now-existing Markdown release-notes document to the Getting Started toctree.
docs/release_notes.md Supplies the release-notes source document required by the updated toctree.
docs/versions1.json Defines the current and archived documentation destinations consumed by the theme switcher.
docs/documentation-archive.rst Adds an orphan archive page linking to documentation for previous releases.

Reviews (11): Last reviewed commit: "Re-adding release notes for vX.YZ" | 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
Deleted orphan file

Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
Comment thread docs/index.rst
installation
getting_started/index
faq
release_notes.md

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 Release notes target is missing

When the documentation workflow builds this toctree, release_notes.md does not resolve to an existing source document, causing a Sphinx warning that SPHINXOPTS="-W" turns into a failed documentation build.

Knowledge Base Used: Verification and CI matrix

Re-adding initial release notes for Transformer Engine vX.YZ.

Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com>
@greptile-apps

greptile-apps Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Want your agent to iterate on Greptile's feedback? Try greploops.

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