From ff8a5104ed6d5ccc0bbfa5ad84853042924201a8 Mon Sep 17 00:00:00 2001 From: "Zenobia \"Z\" Redeaux" <161058543+zredeaux07@users.noreply.github.com> Date: Tue, 18 Aug 2026 13:36:36 -0700 Subject: [PATCH 1/8] Update Sphinx HTML theme and options 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> --- docs/conf.py | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index d2bba9825a..70b472d6f7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -77,26 +77,21 @@ # -- 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" html_theme_options = { - "collapse_navigation": False, - "logo_only": False, - "version_selector": False, - "language_selector": False, + "switcher": { + "json_url": "../versions1.json", + "version_match": release, + }, + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/NVIDIA/Megatron-LM/", + "icon": "fa-brands fa-github", + } + ] } +html_extra_path = ["project.json", "versions1.json"] napoleon_custom_sections = [ ("Parallelism parameters", "params_style"), From 7a76a30c8b3703bcb4fb2eb3b76c44756546f67a Mon Sep 17 00:00:00 2001 From: "Zenobia \"Z\" Redeaux" <161058543+zredeaux07@users.noreply.github.com> Date: Tue, 18 Aug 2026 13:52:03 -0700 Subject: [PATCH 2/8] Add initial release notes placeholder Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com> --- docs/release_notes | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/release_notes diff --git a/docs/release_notes b/docs/release_notes new file mode 100644 index 0000000000..2bbf4d2ac2 --- /dev/null +++ b/docs/release_notes @@ -0,0 +1 @@ +Paste in the latest release notes. From fffd19efcb9a7aceeece0c67fd7b2174e5f7cb6a Mon Sep 17 00:00:00 2001 From: "Zenobia \"Z\" Redeaux" <161058543+zredeaux07@users.noreply.github.com> Date: Tue, 18 Aug 2026 13:53:38 -0700 Subject: [PATCH 3/8] Add release notes to documentation index Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com> --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.rst b/docs/index.rst index fcd15a7a11..a808ac25da 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,6 +31,7 @@ Transformer Engine documentation installation getting_started/index faq + release_notes .. toctree:: :hidden: From 474a2c0da1a078e2decf66c79621f8bfae67bdca Mon Sep 17 00:00:00 2001 From: "Zenobia \"Z\" Redeaux" <161058543+zredeaux07@users.noreply.github.com> Date: Tue, 18 Aug 2026 14:09:13 -0700 Subject: [PATCH 4/8] Apply suggestion from @greptile-apps[bot] 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> --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 70b472d6f7..380b1ba3be 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -86,7 +86,7 @@ "icon_links": [ { "name": "GitHub", - "url": "https://github.com/NVIDIA/Megatron-LM/", + "url": "https://github.com/NVIDIA/TransformerEngine/", "icon": "fa-brands fa-github", } ] From 57562cf45d5d6ef7afcd918b835bf622c182be83 Mon Sep 17 00:00:00 2001 From: "Zenobia \"Z\" Redeaux" <161058543+zredeaux07@users.noreply.github.com> Date: Tue, 18 Aug 2026 14:12:40 -0700 Subject: [PATCH 5/8] Rename release_notes to release_notes.rst Giving the file an extension. Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com> --- docs/{release_notes => release_notes.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{release_notes => release_notes.rst} (100%) diff --git a/docs/release_notes b/docs/release_notes.rst similarity index 100% rename from docs/release_notes rename to docs/release_notes.rst From 6c43d04043b52b0a4edbcd1ec1ef99392101db12 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 18 Aug 2026 21:18:49 +0000 Subject: [PATCH 6/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 380b1ba3be..3301024ba9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -89,7 +89,7 @@ "url": "https://github.com/NVIDIA/TransformerEngine/", "icon": "fa-brands fa-github", } - ] + ], } html_extra_path = ["project.json", "versions1.json"] From 84d0546b061edaf565546791b7c66ff6ba785558 Mon Sep 17 00:00:00 2001 From: "Zenobia \"Z\" Redeaux" <161058543+zredeaux07@users.noreply.github.com> Date: Wed, 19 Aug 2026 10:38:29 -0700 Subject: [PATCH 7/8] Apply suggestion from @mckimn Co-authored-by: mckimn Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com> --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 3301024ba9..c5f103f60f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,6 +59,8 @@ "breathe", "autoapi.extension", "sphinx_tabs.tabs", + "myst_parser", + "nvidia-sphinx-theme", ] templates_path = ["_templates"] From f45f74e15243ae99ccccc520fcaddfeca38125dd Mon Sep 17 00:00:00 2001 From: "Zenobia \"Z\" Redeaux" <161058543+zredeaux07@users.noreply.github.com> Date: Wed, 19 Aug 2026 10:39:29 -0700 Subject: [PATCH 8/8] Apply suggestion from @mckimn Co-authored-by: mckimn Signed-off-by: Zenobia "Z" Redeaux <161058543+zredeaux07@users.noreply.github.com> --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index c5f103f60f..62a77ab9ee 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,6 +81,7 @@ html_theme = "nvidia_sphinx_theme" html_theme_options = { + "public_docs_features": True, "switcher": { "json_url": "../versions1.json", "version_match": release,