Skip to content

Publishing updates #3399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
zredeaux07 wants to merge 8 commits into
base: main
Choose a base branch
from
+18 −18
Draft

Publishing updates #3399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ff8a510
Update Sphinx HTML theme and options
zredeaux07 Aug 18, 2026
7a76a30
Add initial release notes placeholder
zredeaux07 Aug 18, 2026
fffd19e
Add release notes to documentation index
zredeaux07 Aug 18, 2026
474a2c0
Apply suggestion from @greptile-apps[bot]
zredeaux07 Aug 18, 2026
57562cf
Rename release_notes to release_notes.rst
zredeaux07 Aug 18, 2026
6c43d04
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 18, 2026
84d0546
Apply suggestion from @mckimn
zredeaux07 Aug 19, 2026
f45f74e
Apply suggestion from @mckimn
zredeaux07 Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
"breathe",
"autoapi.extension",
"sphinx_tabs.tabs",
"myst_parser",
"nvidia-sphinx-theme",
]

templates_path = ["_templates"]
Expand All @@ -77,26 +79,22 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
html_show_sphinx = False

html_css_files = [
"css/nvidia_font.css",
"css/nvidia_footer.css",
"css/output-style.css",
"css/diagram-colors.css",
"css/sphinx_tabs.css",
"css/svg-responsive.css",
"css/rtabs.css",
]

html_theme = "nvidia_sphinx_theme"

@greptile-apps greptile-apps Bot Aug 18, 2026

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.

html_theme_options = {
"collapse_navigation": False,
"logo_only": False,
"version_selector": False,
"language_selector": False,
"public_docs_features": True,
"switcher": {
Comment thread
zredeaux07 marked this conversation as resolved.
"json_url": "../versions1.json",
"version_match": release,
},
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/NVIDIA/TransformerEngine/",
"icon": "fa-brands fa-github",
}
],
}
html_extra_path = ["project.json", "versions1.json"]

@greptile-apps greptile-apps Bot Aug 18, 2026

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.

@mckimn mckimn Aug 18, 2026

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.


napoleon_custom_sections = [
("Parallelism parameters", "params_style"),
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Transformer Engine documentation
installation
getting_started/index
faq
release_notes

@greptile-apps greptile-apps Bot Aug 18, 2026

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.

@mckimn mckimn Aug 18, 2026

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.


.. toctree::
:hidden:
Expand Down
1 change: 1 addition & 0 deletions docs/release_notes.rst
View file
Open in desktop

@mckimn mckimn Aug 18, 2026

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.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Paste in the latest release notes.

@ksivaman ksivaman Aug 18, 2026

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

@zredeaux07 zredeaux07 Aug 19, 2026

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!

Loading