Skip to content

Publishing updates - #3399

Draft
zredeaux07 wants to merge 8 commits into
NVIDIA:mainfrom
zredeaux07:zredeaux07-publishing
Draft

Publishing updates#3399
zredeaux07 wants to merge 8 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 switches the documentation to NVIDIA's Sphinx theme and adds release-note navigation. It also introduces several documentation build blockers and a GitHub link targeting the wrong repository.

  • Replaces the Read the Docs theme and custom CSS options with NVIDIA theme switcher and icon configuration.
  • Adds release notes to the main documentation toctree.
  • Adds an initial release-notes source file.

Confidence Score: 1/5

The PR is not safe to merge until the documentation theme dependency, missing source and metadata files, and incorrect repository link are corrected.

Current documentation builds cannot load the selected theme, resolve the release-notes toctree target, or copy the configured switcher assets, while the rendered GitHub navigation would direct readers to a different project.

Files Needing Attention: docs/conf.py, docs/index.rst, docs/release_notes

Important Files Changed

Filename Overview
docs/conf.py Changes the theme and navigation metadata, but the theme dependency and extra JSON assets are unavailable and the GitHub icon targets another project.
docs/index.rst Adds a toctree target that cannot resolve because the corresponding file lacks the configured .rst suffix.
docs/release_notes Adds an extensionless placeholder file that Sphinx will not recognize as the release_notes document.

Reviews (1): Last reviewed commit: "Add release notes to documentation index" | Re-trigger Greptile

Comment thread docs/conf.py
"css/rtabs.css",
]

html_theme = "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 Configured theme is unavailable

When CI, nightly publishing, or the documented local build runs, Sphinx loads nvidia_sphinx_theme, but those environments install or clone only sphinx_rtd_theme, causing the documentation build to abort before producing HTML.

Comment thread docs/index.rst
installation
getting_started/index
faq
release_notes

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 Toctree target cannot resolve

When Sphinx builds this toctree, it resolves release_notes using the configured .rst source suffix, but the PR creates only the extensionless docs/release_notes file, causing a nonexistent-document warning that the CI workflow's -W option turns into a build failure.

Comment thread docs/conf.py
}
]
}
html_extra_path = ["project.json", "versions1.json"]

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 Extra-path files are missing

When Sphinx processes html_extra_path, it attempts to copy project.json and versions1.json, but neither file exists and no build step generates them, causing missing-file warnings that fail the -W documentation build and leave the switcher data unavailable.

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This file should either be renamed to "release_notes.md" or the TE team will need to provide the release notes content as RST for future releases. They are currently provided as an MD file.

Comment thread docs/conf.py
exclude_patterns = [
"_build",
"Thumbs.db",
"sphinx_rtd_theme",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change

Comment thread docs/index.rst
installation
getting_started/index
faq
release_notes

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
release_notes
release_notes.md

Only needed if content remains in MD.

Comment thread docs/conf.py
}
],
}
html_extra_path = ["project.json", "versions1.json"]

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

These will need to be created for the project.

Comment thread docs/conf.py
Comment thread docs/release_notes.rst
@@ -0,0 +1 @@
Paste in the latest release notes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should add our copyright header here

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.

Will do! Thank you @ksivaman!

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

3 participants