Publishing updates - #3399
Conversation
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>
Greptile SummaryThe 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.
Confidence Score: 1/5The 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
Reviews (1): Last reviewed commit: "Add release notes to documentation index" | Re-trigger Greptile |
| "css/rtabs.css", | ||
| ] | ||
|
|
||
| html_theme = "nvidia_sphinx_theme" |
| installation | ||
| getting_started/index | ||
| faq | ||
| release_notes |
There was a problem hiding this comment.
| } | ||
| ] | ||
| } | ||
| html_extra_path = ["project.json", "versions1.json"] |
There was a problem hiding this comment.
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>
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
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.
| exclude_patterns = [ | ||
| "_build", | ||
| "Thumbs.db", | ||
| "sphinx_rtd_theme", |
| installation | ||
| getting_started/index | ||
| faq | ||
| release_notes |
There was a problem hiding this comment.
| release_notes | |
| release_notes.md |
Only needed if content remains in MD.
| } | ||
| ], | ||
| } | ||
| html_extra_path = ["project.json", "versions1.json"] |
There was a problem hiding this comment.
These will need to be created for the project.
| @@ -0,0 +1 @@ | |||
| Paste in the latest release notes. | |||
There was a problem hiding this comment.
We should add our copyright header here
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>
Made the following changes: