Skip to content

Commit d4416fa

Browse files
Aditi2424sagemaker-botchad119Chad Chiangadishaa
authored
documentation: Add new theme and pages (#5212)
* change: update jumpstart region_config, update image_uri_configs 06-12-2025 07:18:12 PST * feat: Add support for MetricDefinitions in ModelTrainer (#5202) * feat: Add support for MetricDefinitions in ModelTrainer * style fix * Update model_trainer.py to generate the doc * resolve unit test failed * solve another unit test error --------- Co-authored-by: Chad Chiang <[email protected]> * prepare release v2.247.0 * update development version to v2.247.1.dev0 * change: update image_uri_configs 06-19-2025 07:18:34 PST * prepare release v2.247.1 * update development version to v2.247.2.dev0 * documentation: update theme and add new pages * Add template files for custom logo and navbar --------- Co-authored-by: sagemaker-bot <[email protected]> Co-authored-by: Chad Chiang <[email protected]> Co-authored-by: Chad Chiang <[email protected]> Co-authored-by: ci <ci> Co-authored-by: adishaa <[email protected]>
1 parent 844b558 commit d4416fa

28 files changed

+7695
-644
lines changed

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# Changelog
22

3+
## v2.247.1 (2025-06-23)
4+
5+
### Bug Fixes and Other Changes
6+
7+
* update image_uri_configs 06-19-2025 07:18:34 PST
8+
9+
## v2.247.0 (2025-06-13)
10+
11+
### Features
12+
13+
* Add support for MetricDefinitions in ModelTrainer
14+
15+
### Bug Fixes and Other Changes
16+
17+
* update jumpstart region_config, update image_uri_configs 06-12-2025 07:18:12 PST
18+
* Add ignore_patterns in ModelTrainer to ignore specific files/folders
19+
* Allow import failure for internal _hashlib module
20+
321
## v2.246.0 (2025-06-04)
422

523
### Features

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.246.1.dev0
1+
2.247.2.dev0

doc/_templates/custom-logo.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<a href="#" class="aws-brand">
2+
<img src="https://d1.awsstatic.com/logos/aws-logo-lockups/poweredbyaws/PB_AWS_logo_RGB_stacked_REV_SQ.91cd4af40773cbfbd15577a3c2b8a346fe3e8fa2.png"
3+
alt="AWS Logo"
4+
class="aws-logo">
5+
<span class="aws-title">SageMaker Python SDK</span>
6+
</a>

doc/_templates/navbar-right.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<div class="navbar" style="display: flex; width: 100%;">
2+
<div class="navbar-right-items">
3+
<a href="/guide" class="nav-link">Guide</a>
4+
<a href="/examples" class="nav-link">Examples</a>
5+
<a href="/api" class="nav-link">API Reference</a>
6+
<a href="https://github.com/aws/sagemaker-python-sdk" class="nav-link github-button" target="_blank">GitHub</a>
7+
</div>
8+
</div>
9+

doc/_templates/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
88
:license: BSD, see https://github.com/sphinx-doc/sphinx/blob/master/LICENSE for details.
99
#}
10-
{%- extends "layout.html" %}
10+
{% extends "!layout.html" %}
1111
{% set title = _('Search') %}
1212
{% set display_vcs_links = False %}
1313
{%- block scripts %}

doc/conf.py

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,34 @@
3535
"sphinx.ext.autosummary",
3636
"sphinx.ext.napoleon",
3737
"sphinx.ext.autosectionlabel",
38+
"myst_parser",
39+
"sphinx_design",
40+
"sphinx_tabs.tabs"
3841
]
3942

4043
# Add any paths that contain templates here, relative to this directory.
4144
templates_path = ["_templates"]
4245

43-
source_suffix = ".rst" # The suffix of source filenames.
46+
source_suffix = {
47+
'.rst': 'restructuredtext',
48+
'.md': 'markdown',
49+
}
50+
51+
# MyST parser settings
52+
# myst_heading_anchors = 3
53+
myst_enable_extensions = [
54+
"amsmath",
55+
"colon_fence",
56+
"deflist",
57+
"dollarmath",
58+
"html_admonition",
59+
"html_image",
60+
"replacements",
61+
"smartquotes",
62+
"substitution",
63+
"tasklist",
64+
]
65+
myst_url_schemes = ("http", "https", "mailto")
4466
master_doc = "index" # The master toctree document.
4567

4668
copyright = "%s, Amazon" % datetime.now().year
@@ -58,17 +80,21 @@
5880
autodoc_default_flags = ["show-inheritance", "members", "undoc-members"]
5981
autodoc_member_order = "bysource"
6082

61-
html_theme = "sphinx_rtd_theme"
83+
html_theme = "sphinx_book_theme"
6284

6385
html_theme_options = {
64-
"collapse_navigation": True,
65-
"sticky_navigation": True,
66-
"navigation_depth": 6,
67-
"includehidden": True,
68-
"titles_only": False,
86+
"use_repository_button": False,
87+
"use_edit_page_button": False,
88+
"use_issues_button": False,
89+
"use_download_button": False,
90+
"toc_title": "On This Page",
91+
"navbar_start": ["custom-logo.html"],
92+
"navbar_center": [],
93+
"navbar_end": ["navbar-right.html"],
94+
"navigation_depth": 2,
95+
"collapse_navigation": True
6996
}
7097

71-
7298
html_static_path = ["_static"]
7399

74100
htmlhelp_basename = "%sdoc" % project
@@ -82,10 +108,12 @@
82108
]
83109

84110
html_css_files = [
111+
"https://cdn.jsdelivr.net/npm/[email protected]/dist/tailwind.min.css",
85112
"https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css",
86113
"theme_overrides.css",
87114
"pagination.css",
88115
"search_accessories.css",
116+
"custom.css"
89117
]
90118

91119
# Example configuration for intersphinx: refer to the Python standard library.

0 commit comments

Comments
 (0)