Skip to content

docs: Show V2 deprecation note on every documentation page #6172

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

Merged
lucasjia-aws merged 1 commit into from
Aug 10, 2026
+17 −6
Merged

docs: Show V2 deprecation note on every documentation page #6172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions doc/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,20 @@
{{ super() }}
<meta name="robots" content="noindex">
{% endblock %}

{# Deprecation banner. Overriding the "document" block places this note at the #}
{# top of the main content area of EVERY page -- including theme-generated pages #}
{# with no .rst source (genindex, py-modindex, search) that rst_prolog cannot #}
{# reach. The markup mirrors a Sphinx ".. note::" admonition so it picks up the #}
{# exact same sphinx_rtd_theme styling as the original landing-page note. #}
{% block document %}
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Version 2.x of the SageMaker Python SDK is on a deprecation path.
For the latest features and continued support, see the SageMaker Python SDK
<a class="reference external" href="https://sagemaker.readthedocs.io/">V3 documentation</a>.
For version lifecycle, see
<a class="reference external" href="https://sagemaker.readthedocs.io/en/stable/lifecycle.html">this page</a>.</p>
</div>
{{ super() }}
{% endblock %}
6 changes: 0 additions & 6 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@
Amazon SageMaker Python SDK
###########################

.. note::
Version 2.x of the SageMaker Python SDK is on a deprecation path.
For the latest features and continued support, see the SageMaker Python SDK
`V3 documentation <https://sagemaker.readthedocs.io/>`_.
For version lifecycle, see `this page <https://sagemaker.readthedocs.io/en/stable/lifecycle.html>`_.

Amazon SageMaker Python SDK is an open source library for training and deploying machine-learned models on Amazon SageMaker.

With the SDK, you can train and deploy models using popular deep learning frameworks, algorithms provided by Amazon, or your own algorithms built into SageMaker-compatible Docker images.
Expand Down
Loading