diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9d38d709e4..80ecce3c97 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -21,7 +21,7 @@ jobs: uses: actions/checkout@v3 - name: 'Install dependencies' run: | - pip install sphinx==8.1.3 sphinx_rtd_theme==3.0.1 nbsphinx==0.9.5 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2 astroid==3.3.2 sphinx-tabs==3.4.7 + pip install sphinx==8.1.3 nvidia-sphinx-theme==0.0.9.post1 pydata-sphinx-theme==0.19.0 nbsphinx==0.9.5 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2 astroid==3.3.2 sphinx-tabs==3.4.7 myst-parser==4.0.1 pip install breathe==4.35.0 sphinx-autoapi==3.3.2 sudo apt-get install -y pandoc graphviz doxygen export GIT_SHA=$(git show-ref --hash HEAD) diff --git a/docs/.gitignore b/docs/.gitignore index 409af2d74e..b26c4f6ccc 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,3 +1,2 @@ _build doxygen -sphinx_rtd_theme \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile index 800eeea78a..c7271eadef 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -16,10 +16,5 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile sphinx_rtd_theme - PYTHONPATH=sphinx_rtd_theme:$(PYTHONPATH) $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -# Patch Sphinx RTD theme 3.0.1 to add version selector in sidebar -sphinx_rtd_theme: - git clone --depth=1 -b 3.0.1 --single-branch https://github.com/readthedocs/sphinx_rtd_theme.git - bash -c "cd sphinx_rtd_theme; git apply ../version_select.patch" +%: Makefile + $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/NVIDIA-LogoBlack.svg b/docs/_static/NVIDIA-LogoBlack.svg deleted file mode 100644 index c612396c71..0000000000 --- a/docs/_static/NVIDIA-LogoBlack.svg +++ /dev/null @@ -1 +0,0 @@ -NVIDIA-LogoBlack \ No newline at end of file diff --git a/docs/_static/css/nvidia_font.css b/docs/_static/css/nvidia_font.css deleted file mode 100644 index 0c544779bb..0000000000 --- a/docs/_static/css/nvidia_font.css +++ /dev/null @@ -1,53 +0,0 @@ -@font-face { - font-family: NVIDIA; - font-style: normal; - font-weight: 300; - src: url(https://images.nvidia.com/etc/designs/nvidiaGDC/clientlibs_base/fonts/nvidia-sans/GLOBAL/NVIDIASans_W_Lt.woff) format("woff"),url(https://images.nvidia.com/etc/designs/nvidiaGDC/clientlibs_base/fonts/nvidia-sans/GLOBAL/NVIDIASans_W_Lt.woff2) format("woff2") -} - -@font-face { - font-family: NVIDIA; - font-style: normal; - font-weight: 400; - src: url(https://images.nvidia.com/etc/designs/nvidiaGDC/clientlibs_base/fonts/nvidia-sans/GLOBAL/NVIDIASans_W_Rg.woff) format("woff"),url(https://images.nvidia.com/etc/designs/nvidiaGDC/clientlibs_base/fonts/nvidia-sans/GLOBAL/NVIDIASans_W_Rg.woff2) format("woff2") -} - -@font-face { - font-family: NVIDIA; - font-style: normal; - font-weight: 500; - src: url(https://images.nvidia.com/etc/designs/nvidiaGDC/clientlibs_base/fonts/nvidia-sans/GLOBAL/NVIDIASans_W_Md.woff) format("woff"),url(https://images.nvidia.com/etc/designs/nvidiaGDC/clientlibs_base/fonts/nvidia-sans/GLOBAL/NVIDIASans_W_Md.woff2) format("woff2") -} - -@font-face { - font-family: NVIDIA; - font-style: normal; - font-weight: 700; - src: url(https://images.nvidia.com/etc/designs/nvidiaGDC/clientlibs_base/fonts/nvidia-sans/GLOBAL/NVIDIASans_W_Bd.woff) format("woff"),url(https://images.nvidia.com/etc/designs/nvidiaGDC/clientlibs_base/fonts/nvidia-sans/GLOBAL/NVIDIASans_W_Bd.woff2) format("woff2") -} - -body { - font-family: NVIDIA,Lato,proxima-nova,Helvetica Neue,Arial,sans-serif; -} - -.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend { - margin-top: 0; - font-weight: 700; - font-family: NVIDIA,Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif -} - -input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week] { - font-family: NVIDIA,Lato,proxima-nova,Helvetica Neue,Arial,sans-serif; -} - -select { - font-family: NVIDIA,Lato,proxima-nova,Helvetica Neue,Arial,sans-serif; -} - -.btn { - font-family: NVIDIA,Lato,proxima-nova,Helvetica Neue,Arial,sans-serif; -} - -html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .sig-name { - font-family: NVIDIA,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace; -} diff --git a/docs/_static/css/nvidia_footer.css b/docs/_static/css/nvidia_footer.css deleted file mode 100644 index 9d18fb3b47..0000000000 --- a/docs/_static/css/nvidia_footer.css +++ /dev/null @@ -1,29 +0,0 @@ -footer img { - display: block; - width: 137.5px; - position: relative; - left: -9px; - margin: 0 0 15px 0; -} - -footer p { - color: #666666; - font-weight: normal; - font-size: 12px; - line-height: 1.25em; -} - -footer p:not(.notices) { - display: inline; - margin: 0; -} - -footer p a, -footer p a:link, -footer p a:visited { - color: #666666; -} - -footer p a:hover { - color: #666666; -} diff --git a/docs/_static/css/rtabs.css b/docs/_static/css/rtabs.css deleted file mode 100644 index 7f4213ef99..0000000000 --- a/docs/_static/css/rtabs.css +++ /dev/null @@ -1,43 +0,0 @@ -/* Custom styling for sphinx-tabs */ - -.sphinx-tabs { - margin-bottom: 1rem; -} - -.sphinx-tabs-tab { - background-color: #f4f4f4; - border: 1px solid #ccc; - border-bottom: none; - padding: 0.5rem 1rem; - margin-right: 0.5rem; - cursor: pointer; - font-weight: 500; - transition: background-color 0.2s; -} - -.sphinx-tabs-tab:hover { - background-color: #e0e0e0; -} - -.sphinx-tabs-tab[aria-selected="true"] { - background-color: #76b900; /* NVIDIA green */ - color: white; - border-color: #76b900; - margin-right: 0.5rem; -} - -.sphinx-tabs-panel { - border: 1px solid #ccc; - padding: 1rem; - background-color: #f9f9f9; -} - -/* Dark mode support for RTD theme */ -.rst-content .sphinx-tabs-tab { - color: #333; -} - -.rst-content .sphinx-tabs-tab[aria-selected="true"] { - color: white; -} - diff --git a/docs/_static/css/sphinx_tabs.css b/docs/_static/css/sphinx_tabs.css index c3e524e0e9..ecb2e2e00f 100644 --- a/docs/_static/css/sphinx_tabs.css +++ b/docs/_static/css/sphinx_tabs.css @@ -32,14 +32,3 @@ background-color: #f9f9f9; } -/* Dark mode support for RTD theme */ -.rst-content .sphinx-tabs-tab { - color: #333; -} - -.rst-content .sphinx-tabs-tab[aria-selected="true"] { - color: white; -} - - - diff --git a/docs/_static/css/svg-responsive.css b/docs/_static/css/svg-responsive.css index 3ffe14eb14..fe66b0524d 100644 --- a/docs/_static/css/svg-responsive.css +++ b/docs/_static/css/svg-responsive.css @@ -3,7 +3,7 @@ /* Make all SVG images responsive */ .document svg, .document object[type="image/svg+xml"], -.rst-content svg { +.bd-content svg { max-width: 100%; height: auto; display: block; @@ -69,4 +69,3 @@ - diff --git a/docs/_static/nvidia-logo-horiz-rgb-1c-blk-for-screen.svg b/docs/_static/nvidia-logo-horiz-rgb-1c-blk-for-screen.svg new file mode 100644 index 0000000000..900395542a --- /dev/null +++ b/docs/_static/nvidia-logo-horiz-rgb-1c-blk-for-screen.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/_static/nvidia-logo-horiz-rgb-1c-wht-for-screen.svg b/docs/_static/nvidia-logo-horiz-rgb-1c-wht-for-screen.svg new file mode 100644 index 0000000000..45f6c6437f --- /dev/null +++ b/docs/_static/nvidia-logo-horiz-rgb-1c-wht-for-screen.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/_static/nvidia-logo-horiz-rgb-blk-for-screen.svg b/docs/_static/nvidia-logo-horiz-rgb-blk-for-screen.svg new file mode 100644 index 0000000000..08844b77b9 --- /dev/null +++ b/docs/_static/nvidia-logo-horiz-rgb-blk-for-screen.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/_static/nvidia-logo-horiz-rgb-wht-for-screen.svg b/docs/_static/nvidia-logo-horiz-rgb-wht-for-screen.svg new file mode 100644 index 0000000000..6798f1596a --- /dev/null +++ b/docs/_static/nvidia-logo-horiz-rgb-wht-for-screen.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html deleted file mode 100644 index 1ef5505d34..0000000000 --- a/docs/_templates/footer.html +++ /dev/null @@ -1,23 +0,0 @@ -{% extends '!footer.html' %} - -{% block contentinfo %} - -

-Privacy Policy -| -Manage My Privacy -| -Do Not Sell or Share My Data -| -Terms of Service -| -Accessibility -| -Corporate Policies -| -Product Security -| -Contact -

-{{ super() }} -{% endblock %} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html deleted file mode 100644 index 99ae0702a8..0000000000 --- a/docs/_templates/layout.html +++ /dev/null @@ -1,103 +0,0 @@ -{% extends "!layout.html" %} - - {% block extrahead %} - - - - {% endblock %} - - {% block sidebartitle %} {{ super() }} - - - - - {% endblock %} - - {% block footer %} - - - - {% endblock %} diff --git a/docs/conf.py b/docs/conf.py index d2bba9825a..6f3a891cae 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,7 +9,7 @@ from builtins import str # Basic project info -project = "Transformer Engine" +project_name = "Transformer Engine" author = "NVIDIA CORPORATION & AFFILIATES" # Copyright statement @@ -46,6 +46,7 @@ else: version = str(_raw_version) release = _raw_version +project = f"{project_name} {release}" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -59,16 +60,18 @@ "breathe", "autoapi.extension", "sphinx_tabs.tabs", + "myst_parser", ] -templates_path = ["_templates"] exclude_patterns = [ "_build", "Thumbs.db", - "sphinx_rtd_theme", ] -source_suffix = ".rst" +source_suffix = { + ".rst": "restructuredtext", + ".md": "markdown", +} master_doc = "index" @@ -77,26 +80,38 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "sphinx_rtd_theme" +html_theme = "nvidia_sphinx_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", ] +# Allow local previews to test the version switcher before the production JSON is published. +switcher_json_url = os.getenv( + "NVTE_DOCS_SWITCHER_JSON_URL", + "https://docs.nvidia.com/deeplearning/transformer-engine/versions1.json", +) +switcher_version = os.getenv("NVTE_DOCS_SWITCHER_VERSION", "latest") + html_theme_options = { - "collapse_navigation": False, - "logo_only": False, - "version_selector": False, - "language_selector": False, + "public_docs_features": True, + "switcher": { + "json_url": switcher_json_url, + "version_match": switcher_version, + }, + "check_switcher": False, + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/NVIDIA/TransformerEngine/", + "icon": "fa-brands fa-github", + } + ], } +html_extra_path = ["versions1.json"] napoleon_custom_sections = [ ("Parallelism parameters", "params_style"), diff --git a/docs/documentation-archive.rst b/docs/documentation-archive.rst new file mode 100644 index 0000000000..e74875aba2 --- /dev/null +++ b/docs/documentation-archive.rst @@ -0,0 +1,159 @@ +.. + Copyright (c) 2022-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. + + See LICENSE for license information. + +:orphan: + +Documentation Archive +===================== + +Documentation for all releases of NVIDIA Transformer Engine are referenced below. The current release is first. + +.. list-table:: + :header-rows: 1 + :widths: 30 70 + + * - Release + - Documentation + * - 2.18 + - | `User Guide <../transformer-engine-releases/release-2.18/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.18/release-notes/index.html>`__ + * - 2.17 + - | `User Guide <../transformer-engine-releases/release-2.17/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.17/release-notes/index.html>`__ + * - 2.16 + - | `User Guide <../transformer-engine-releases/release-2.16/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.16/release-notes/index.html>`__ + * - 2.15 + - | `User Guide <../transformer-engine-releases/release-2.15/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.15/release-notes/index.html>`__ + * - 2.14 + - | `User Guide <../transformer-engine-releases/release-2.14/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.14/release-notes/index.html>`__ + * - 2.13 + - | `User Guide <../transformer-engine-releases/release-2.13/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.13/release-notes/index.html>`__ + * - 2.12 + - | `User Guide <../transformer-engine-releases/release-2.12/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.12/release-notes/index.html>`__ + * - 2.11 + - | `User Guide <../transformer-engine-releases/release-2.11/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.11/release-notes/index.html>`__ + * - 2.10 + - | `User Guide <../transformer-engine-releases/release-2.10/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.10/release-notes/index.html>`__ + * - 2.9 + - | `User Guide <../transformer-engine-releases/release-2.9/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.9/release-notes/index.html>`__ + * - 2.8 + - | `User Guide <../transformer-engine-releases/release-2.8/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.8/release-notes/index.html>`__ + * - 2.7 + - | `User Guide <../transformer-engine-releases/release-2.7/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.7/release-notes/index.html>`__ + * - 2.6 + - | `User Guide <../transformer-engine-releases/release-2.6/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.6/release-notes/index.html>`__ + * - 2.5 + - | `User Guide <../transformer-engine-releases/release-2.5/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.5/release-notes/index.html>`__ + * - 2.4 + - | `User Guide <../transformer-engine-releases/release-2.4/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.4/release-notes/index.html>`__ + * - 2.3 + - | `User Guide <../transformer-engine-releases/release-2.3/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.3/release-notes/index.html>`__ + * - 2.2 + - | `User Guide <../transformer-engine-releases/release-2.2/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.2/release-notes/index.html>`__ + * - 2.1 + - | `User Guide <../transformer-engine-releases/release-2.1/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.1/release-notes/index.html>`__ + * - 2.0 + - | `User Guide <../transformer-engine-releases/release-2.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-2.0/release-notes/index.html>`__ + * - 1.13 + - | `User Guide <../transformer-engine-releases/release-1.13/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.13/release-notes/index.html>`__ + * - 1.12 + - | `User Guide <../transformer-engine-releases/release-1.12/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.12/release-notes/index.html>`__ + * - 1.11 + - | `User Guide <../transformer-engine-releases/release-1.11/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.11/release-notes/index.html>`__ + * - 1.10 + - | `User Guide <../transformer-engine-releases/release-1.10/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.10/release-notes/index.html>`__ + * - 1.9 + - | `User Guide <../transformer-engine-releases/release-1.9/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.9/release-notes/index.html>`__ + * - 1.8 + - | `User Guide <../transformer-engine-releases/release-1.8/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.8/release-notes/index.html>`__ + * - 1.7 + - | `User Guide <../transformer-engine-releases/release-1.7/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.7/release-notes/index.html>`__ + * - 1.6 + - | `User Guide <../transformer-engine-releases/release-1.6/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.6/release-notes/index.html>`__ + * - 1.5 + - | `User Guide <../transformer-engine-releases/release-1.5/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.5/release-notes/index.html>`__ + * - 1.4 + - | `User Guide <../transformer-engine-releases/release-1.4/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.4/release-notes/index.html>`__ + * - 1.3 + - | `User Guide <../transformer-engine-releases/release-1.3/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.3/release-notes/index.html>`__ + * - 1.2.1 + - | `User Guide <../transformer-engine-releases/release-1.2.1/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.2.1/release-notes/index.html>`__ + * - 1.2.0 + - | `User Guide <../transformer-engine-releases/release-1.2.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.2.0/release-notes/index.html>`__ + * - 1.1.0 + - | `User Guide <../transformer-engine-releases/release-1.1.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.1.0/release-notes/index.html>`__ + * - 1.0.0 + - | `User Guide <../transformer-engine-releases/release-1.0.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-1.0.0/release-notes/index.html>`__ + * - 0.13.0 + - | `User Guide <../transformer-engine-releases/release-0.13.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.13.0/release-notes/index.html>`__ + * - 0.12.0 + - | `User Guide <../transformer-engine-releases/release-0.12.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.12.0/release-notes/index.html>`__ + * - 0.11.0 + - | `User Guide <../transformer-engine-releases/release-0.11.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.11.0/release-notes/index.html>`__ + * - 0.10.0 + - | `User Guide <../transformer-engine-releases/release-0.10.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.10.0/release-notes/index.html>`__ + * - 0.9.0 + - | `User Guide <../transformer-engine-releases/release-0.9.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.9.0/release-notes/index.html>`__ + * - 0.8.0 + - | `User Guide <../transformer-engine-releases/release-0.8.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.8.0/release-notes/index.html>`__ + * - 0.7.0 + - | `User Guide <../transformer-engine-releases/release-0.7.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.7.0/release-notes/index.html>`__ + * - 0.6.0 + - | `User Guide <../transformer-engine-releases/release-0.6.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.6.0/release-notes/index.html>`__ + * - 0.5.0 + - | `User Guide <../transformer-engine-releases/release-0.5.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.5.0/release-notes/index.html>`__ + * - 0.4.0 + - | `User Guide <../transformer-engine-releases/release-0.4.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.4.0/release-notes/index.html>`__ + * - 0.3.0 + - | `User Guide <../transformer-engine-releases/release-0.3.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.3.0/release-notes/index.html>`__ + * - 0.2.0 + - | `User Guide <../transformer-engine-releases/release-0.2.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.2.0/release-notes/index.html>`__ + * - 0.1.0 + - | `User Guide <../transformer-engine-releases/release-0.1.0/user-guide/index.html>`__ + | `Release Notes <../transformer-engine-releases/release-0.1.0/release-notes/index.html>`__ diff --git a/docs/index.rst b/docs/index.rst index fcd15a7a11..5dad5fdd83 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,7 @@ See LICENSE for license information. Transformer Engine documentation -================================= +================================================= .. ifconfig:: "dev" in release @@ -31,6 +31,7 @@ Transformer Engine documentation installation getting_started/index faq + release_notes.md .. toctree:: :hidden: diff --git a/docs/release_notes.md b/docs/release_notes.md new file mode 100644 index 0000000000..f2b0450cef --- /dev/null +++ b/docs/release_notes.md @@ -0,0 +1,17 @@ +# Transformer Engine vX.Y Release Notes + +## Key Features and Enhancements + +- + +## Fixed Issues + +- + +## Breaking Changes in This Release + +There are no breaking changes in this release. + +## Deprecated Features + +There are no deprecated features in this release. diff --git a/docs/version_select.patch b/docs/version_select.patch deleted file mode 100644 index 75f29fff81..0000000000 --- a/docs/version_select.patch +++ /dev/null @@ -1,21 +0,0 @@ -diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html -index e6a38b1..579eaec 100644 ---- a/sphinx_rtd_theme/layout.html -+++ b/sphinx_rtd_theme/layout.html -@@ -124,6 +124,16 @@ - {%- endif %} - - -+ {# Show TE version and version selector #} -+
-+ {{ version }} -+
-+ Version select: -+
-+ - {%- if READTHEDOCS or DEBUG %} - {%- if theme_version_selector or theme_language_selector %} -
diff --git a/docs/versions1.json b/docs/versions1.json new file mode 100644 index 0000000000..1c45c632f4 --- /dev/null +++ b/docs/versions1.json @@ -0,0 +1,13 @@ +[ + { + "name": "Latest", + "version": "latest", + "url": "https://docs.nvidia.com/deeplearning/transformer-engine/", + "preferred": true + }, + { + "name": "Older releases", + "version": "archives", + "url": "https://docs.nvidia.com/deeplearning/transformer-engine/documentation-archive.html" + } +]