Skip to content

Commit 59f137d

Browse files
committed
Update v3 readthedocs to autorender all submodules
1 parent 2afbe28 commit 59f137d

6 files changed

Lines changed: 37 additions & 121 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,4 @@ sagemaker_train/src/**/container_drivers/sm_train.sh
4141
sagemaker_train/src/**/container_drivers/sourcecode.json
4242
sagemaker_train/src/**/container_drivers/distributed.json
4343
.kiro
44+
docs/api/generated/

docs/api/sagemaker_core.rst

Lines changed: 4 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -3,58 +3,8 @@ SageMaker Core
33

44
Core SageMaker resources and utilities for managing AWS SageMaker services.
55

6-
.. currentmodule:: sagemaker.core
6+
.. autosummary::
7+
:toctree: generated/
8+
:recursive:
79

8-
Core Resources
9-
--------------
10-
11-
.. automodule:: sagemaker.core.resources
12-
:members:
13-
:undoc-members:
14-
:show-inheritance:
15-
16-
Session Management
17-
------------------
18-
19-
.. automodule:: sagemaker.core.session_settings
20-
:members:
21-
:undoc-members:
22-
23-
Configuration
24-
-------------
25-
26-
.. automodule:: sagemaker.core.config_schema
27-
:members:
28-
:undoc-members:
29-
30-
Processing
31-
----------
32-
33-
.. automodule:: sagemaker.core.processing
34-
:members:
35-
:undoc-members:
36-
37-
Transformers
38-
------------
39-
40-
.. automodule:: sagemaker.core.transformer
41-
:members:
42-
:undoc-members:
43-
44-
Utilities
45-
---------
46-
47-
.. automodule:: sagemaker.core.common_utils
48-
:members:
49-
:undoc-members:
50-
51-
.. automodule:: sagemaker.core.image_uris
52-
:members:
53-
:undoc-members:
54-
55-
Exceptions
56-
----------
57-
58-
.. automodule:: sagemaker.core.exceptions
59-
:members:
60-
:undoc-members:
10+
sagemaker.core

docs/api/sagemaker_mlops.rst

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,8 @@ SageMaker MLOps
33

44
MLOps capabilities including pipelines, workflows, and model management.
55

6-
.. currentmodule:: sagemaker.mlops
6+
.. autosummary::
7+
:toctree: generated/
8+
:recursive:
79

8-
Pipeline Management
9-
-------------------
10-
11-
.. automodule:: sagemaker.mlops
12-
:members:
13-
:undoc-members:
14-
:show-inheritance:
15-
16-
Workflow Management
17-
-------------------
18-
19-
.. automodule:: sagemaker.mlops.workflow
20-
:members:
21-
:undoc-members:
22-
:show-inheritance:
23-
24-
Local Development
25-
-----------------
26-
27-
.. automodule:: sagemaker.mlops.local
28-
:members:
29-
:undoc-members:
30-
:show-inheritance:
31-
32-
33-
Feature Store
34-
-------------
35-
36-
.. automodule:: sagemaker.mlops.feature_store
37-
:members:
38-
:undoc-members:
39-
:show-inheritance:
10+
sagemaker.mlops

docs/api/sagemaker_serve.rst

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,8 @@ SageMaker Serve
33

44
Model serving and inference capabilities for deploying and managing ML models.
55

6-
.. currentmodule:: sagemaker.serve
6+
.. autosummary::
7+
:toctree: generated/
8+
:recursive:
79

8-
Model Deployment
9-
----------------
10-
11-
.. automodule:: sagemaker.serve
12-
:members:
13-
:undoc-members:
14-
:show-inheritance:
10+
sagemaker.serve

docs/api/sagemaker_train.rst

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,10 @@
11
SageMaker Train
22
===============
33

4-
Training capabilities including model training, hyperparameter tuning, and distributed training.
4+
Training capabilities including model training, fine-tuning, hyperparameter tuning, and distributed training.
55

6-
.. currentmodule:: sagemaker.train
6+
.. autosummary::
7+
:toctree: generated/
8+
:recursive:
79

8-
Model Training
9-
--------------
10-
11-
.. automodule:: sagemaker.train
12-
:members:
13-
:undoc-members:
14-
:show-inheritance:
15-
16-
Distributed Training
17-
--------------------
18-
19-
.. automodule:: sagemaker.train.distributed
20-
:members:
21-
:undoc-members:
22-
:show-inheritance:
23-
24-
Model Evaluation
25-
----------------
26-
27-
.. automodule:: sagemaker.train.evaluate
28-
:members:
29-
:undoc-members:
30-
:show-inheritance:
10+
sagemaker.train

docs/conf.py

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
suppress_warnings = [
4040
'myst.header', # Suppress header level warnings from notebooks
4141
'toc.not_readable', # Suppress toctree warnings for symlinked files
42+
'ref.python', # Suppress "more than one target found" for duplicate class names across modules
4243
]
4344

4445
html_theme = 'sphinx_book_theme'
@@ -76,11 +77,28 @@
7677
'members': True,
7778
'undoc-members': True,
7879
'show-inheritance': True,
80+
'private-members': False,
7981
}
8082

81-
# Generate autosummary stubs
83+
# Generate autosummary stubs recursively
8284
autosummary_generate = True
8385

86+
# Suppress internal/implementation modules not intended for users
87+
exclude_patterns += [
88+
'*/telemetry*',
89+
'*/tools*',
90+
'*/container_drivers*',
91+
'*/runtime_environment*',
92+
'*/model_server*',
93+
'*/detector*',
94+
'*/validations*',
95+
]
96+
97+
# Modules that fail to import due to runtime dependencies or side effects
98+
autodoc_mock_imports = [
99+
'triton_python_backend_utils',
100+
]
101+
84102
# Don't mock imports - let them fail gracefully and show what's available
85103
autodoc_mock_imports = []
86104
suppress_warnings = ['autodoc.import_error']

0 commit comments

Comments
 (0)