diff --git a/CHANGELOG.md b/CHANGELOG.md index 8874c88af..e06c97159 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,13 @@ limitations under the License. ## Changelog All notable changes to this project will be documented in this file. +## [1.2.1] - 2025-08-20 +### ๐Ÿ“ฆ Overview +This is a documentation only release, there are no code changes in this release. + +### ๐Ÿ“œ Full Change Log +* Add a version switcher to the documentation builds https://github.com/NVIDIA/NeMo-Agent-Toolkit/pull/681 + ## [1.2.0] - 2025-08-20 ### ๐Ÿ“ฆ Overview The NeMo Agent toolkit, formerly known as Agent Intelligence (AIQ) toolkit, has been renamed to align with the NVIDIA NeMo family of products. This release brings significant new capabilities and improvements across authentication, resource management, observability, and developer experience. The toolkit continues to offer backwards compatibility, making the transition seamless for existing users. diff --git a/README.md b/README.md index 4721a921f..d98cad57d 100644 --- a/README.md +++ b/README.md @@ -141,7 +141,7 @@ More information on how to install the latest development version and contribute ## ๐Ÿ“š Additional Resources - * ๐Ÿ“– [Documentation](https://docs.nvidia.com/nemo/agent-toolkit): Explore the full documentation for NeMo Agent toolkit. + * ๐Ÿ“– [Documentation](https://docs.nvidia.com/nemo/agent-toolkit/latest): Explore the full documentation for NeMo Agent toolkit. * ๐Ÿงญ [Get Started Guide](./docs/source/quick-start/installing.md): Set up your environment and start building with NeMo Agent toolkit. * ๐Ÿงช [Examples](./examples/README.md): Explore examples of NeMo Agent toolkit workflows located in the [`examples`](./examples) directory of the source repository. * ๐Ÿ› ๏ธ [Create and Customize NeMo Agent toolkit Workflows](docs/source/tutorials/customize-a-workflow.md): Learn how to create and customize NeMo Agent toolkit workflows. diff --git a/ci/release/update-version.sh b/ci/release/update-version.sh index 151735360..ea6287f00 100755 --- a/ci/release/update-version.sh +++ b/ci/release/update-version.sh @@ -54,7 +54,7 @@ function sed_runner() { # Currently only the pypi.md file for the nvidia-nat package contains links to documentation # Replace this with a `find ./ -name "pypi.md"` if this is needed for the other pypi.md files if [[ -z "${SKIP_MD_UPDATE}" ]]; then - sed_runner "s|https:\/\/docs.nvidia.com\/nemo\/agent-toolkit\/\([0-9|\.]\+\)|https:\/\/docs.nvidia.com\/nemo\/agent-toolkit\/${NEXT_VERSION}|g" src/nat/meta/pypi.md + sed_runner "s|https:\/\/docs.nvidia.com\/nemo\/agent-toolkit\/\([0-9|\.]\+\)|https:\/\/docs.nvidia.com\/nemo\/agent-toolkit\/${NEXT_SHORT_TAG}|g" src/nat/meta/pypi.md fi diff --git a/ci/scripts/path_checks.py b/ci/scripts/path_checks.py index 221d28594..4b1bd79e6 100644 --- a/ci/scripts/path_checks.py +++ b/ci/scripts/path_checks.py @@ -172,6 +172,8 @@ r"^manifest.yaml$", # # files located within data directories r"data/.*$", # + # Versions json file for the documentation version switcher button + r"^docs/source/versions1.json$", } # Paths to ignore -- regex pattern diff --git a/docs/source/conf.py b/docs/source/conf.py index 75008eea1..033e8d2ed 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -63,7 +63,7 @@ # Retrieve the version number from git via setuptools_scm called_proc = subprocess.run('python -m setuptools_scm', shell=True, capture_output=True, check=True) release = called_proc.stdout.strip().decode('utf-8') -version = '.'.join(release.split('.')[:3]) +version = '.'.join(release.split('.')[:2]) # -- General configuration --------------------------------------------------- @@ -181,9 +181,13 @@ html_logo = '_static/main_nv_logo_square.png' html_title = f'{project} ({version})' +# Setting check_switcher to False, since we are building the version switcher for the first time, the json_url will +# return 404s, which will then cause the build to fail. html_theme_options = { - 'collapse_navigation': False, - 'navigation_depth': 6, + 'collapse_navigation': + False, + 'navigation_depth': + 6, 'extra_head': [ # Adding Adobe Analytics ''' @@ -194,9 +198,22 @@ ''' ], - "show_nav_level": 2 + "show_nav_level": + 2, + "switcher": { + "json_url": "../versions1.json", "version_match": version + }, + "check_switcher": + False, + "icon_links": [{ + "name": "GitHub", + "url": "https://github.com/NVIDIA/NeMo-Agent-Toolkit", + "icon": "fa-brands fa-github", + }], } +html_extra_path = ["versions1.json"] + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". diff --git a/docs/source/release-notes.md b/docs/source/release-notes.md index 80fa1fa7a..ba1af8d7f 100644 --- a/docs/source/release-notes.md +++ b/docs/source/release-notes.md @@ -17,6 +17,10 @@ limitations under the License. # NVIDIA NeMo Agent Toolkit Release Notes +## Release 1.2.1 +### Summary +This is a documentation only release, there are no code changes in this release. + ## Release 1.2.0 ### Summary The NeMo Agent toolkit, formerly known as Agent Intelligence (AIQ) toolkit, has been renamed in this release to align with the NVIDIA NeMo family of products. This release also brings significant new capabilities and improvements across authentication, resource management, observability, and developer experience. The toolkit continues to offer backwards compatibility, making the transition seamless for existing users. diff --git a/docs/source/versions1.json b/docs/source/versions1.json new file mode 100644 index 000000000..8299c6a96 --- /dev/null +++ b/docs/source/versions1.json @@ -0,0 +1,15 @@ +[ + { + "preferred": true, + "version": "1.2", + "url": "../1.2/" + }, + { + "version": "1.1", + "url": "../1.1/" + }, + { + "version": "1.0", + "url": "../1.0/" + } +] diff --git a/src/nat/meta/pypi.md b/src/nat/meta/pypi.md index dbd3fd14a..7b66f300f 100644 --- a/src/nat/meta/pypi.md +++ b/src/nat/meta/pypi.md @@ -23,19 +23,19 @@ NeMo Agent toolkit is a flexible library designed to seamlessly integrate your e ## Key Features -- [**Framework Agnostic:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/extend/plugins.html) Works with any agentic framework, so you can use your current technology stack without replatforming. -- [**Reusability:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/extend/sharing-components.html) Every agent, tool, or workflow can be combined and repurposed, allowing developers to leverage existing work in new scenarios. -- [**Rapid Development:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/tutorials/index.html) Start with a pre-built agent, tool, or workflow, and customize it to your needs. -- [**Profiling:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/workflows/profiler.html) Profile entire workflows down to the tool and agent level, track input/output tokens and timings, and identify bottlenecks. -- [**Observability:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/workflows/observe/observe-workflow-with-phoenix.html) Monitor and debug your workflows with any OpenTelemetry-compatible observability tool, with examples using [Phoenix](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/workflows/observe/observe-workflow-with-phoenix.html) and [W&B Weave](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/workflows/observe/observe-workflow-with-weave.html). -- [**Evaluation System:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/workflows/evaluate.html) Validate and maintain accuracy of agentic workflows with built-in evaluation tools. -- [**User Interface:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/quick-start/launching-ui.html) Use the NeMo Agent toolkit UI chat interface to interact with your agents, visualize output, and debug workflows. -- [**MCP Compatibility**](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/workflows/mcp/mcp-client.html) Compatible with Model Context Protocol (MCP), allowing tools served by MCP Servers to be used as NeMo Agent toolkit functions. +- [**Framework Agnostic:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2/extend/plugins.html) Works with any agentic framework, so you can use your current technology stack without replatforming. +- [**Reusability:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2/extend/sharing-components.html) Every agent, tool, or workflow can be combined and repurposed, allowing developers to leverage existing work in new scenarios. +- [**Rapid Development:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2/tutorials/index.html) Start with a pre-built agent, tool, or workflow, and customize it to your needs. +- [**Profiling:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2/workflows/profiler.html) Profile entire workflows down to the tool and agent level, track input/output tokens and timings, and identify bottlenecks. +- [**Observability:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2/workflows/observe/observe-workflow-with-phoenix.html) Monitor and debug your workflows with any OpenTelemetry-compatible observability tool, with examples using [Phoenix](https://docs.nvidia.com/nemo/agent-toolkit/1.2/workflows/observe/observe-workflow-with-phoenix.html) and [W&B Weave](https://docs.nvidia.com/nemo/agent-toolkit/1.2/workflows/observe/observe-workflow-with-weave.html). +- [**Evaluation System:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2/workflows/evaluate.html) Validate and maintain accuracy of agentic workflows with built-in evaluation tools. +- [**User Interface:**](https://docs.nvidia.com/nemo/agent-toolkit/1.2/quick-start/launching-ui.html) Use the NeMo Agent toolkit UI chat interface to interact with your agents, visualize output, and debug workflows. +- [**MCP Compatibility**](https://docs.nvidia.com/nemo/agent-toolkit/1.2/workflows/mcp/mcp-client.html) Compatible with Model Context Protocol (MCP), allowing tools served by MCP Servers to be used as NeMo Agent toolkit functions. With NeMo Agent toolkit, you can move quickly, experiment freely, and ensure reliability across all your agent-driven projects. ## Links - * [Documentation](https://docs.nvidia.com/nemo/agent-toolkit/1.2.0/index.html): Explore the full documentation for NeMo Agent toolkit. + * [Documentation](https://docs.nvidia.com/nemo/agent-toolkit/1.2/index.html): Explore the full documentation for NeMo Agent toolkit. ## First time user? If this is your first time using NeMo Agent toolkit, it is recommended to install the latest version from the [source repository](https://github.com/NVIDIA/NeMo-Agent-Toolkit?tab=readme-ov-file#quick-start) on GitHub. This package is intended for users who are familiar with NeMo Agent toolkit applications and need to add NeMo Agent toolkit as a dependency to their project.