Fix API reference docs to auto-discover all public modules#5737
Merged
mollyheamazon merged 3 commits intoaws:masterfrom Apr 8, 2026
Merged
Fix API reference docs to auto-discover all public modules#5737mollyheamazon merged 3 commits intoaws:masterfrom
mollyheamazon merged 3 commits intoaws:masterfrom
Conversation
Contributor
Author
|
Check the new build to see the updated doc: https://sagemaker--5737.org.readthedocs.build/en/5737/ Current v3 documentation is missing many submodules: https://sagemaker.readthedocs.io/en/stable/api/index.html |
aviruthen
previously approved these changes
Apr 8, 2026
aviruthen
approved these changes
Apr 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
The API reference docs were manually listing only a handful of modules per subpackage, leaving most user-facing classes (e.g.
ModelTrainer, SFTTrainer, ModelBuilder, Pipeline, sagemaker.core.shapes) undocumented on the readthedocs site.Changes:
.. automodule::entries in all 4 API RST files (sagemaker_core, sagemaker_train, sagemaker_serve, sagemaker_mlops) with.. autosummary:: :recursive:conf.pyto suppressinternal/non-user-facingmodules (telemetry, tools, container_drivers, runtime_environment, model_server, detector, validations) and suppress known duplicate cross-reference warnings caused by shared class names across modulesdocs/api/generated/to.gitignore— this directory is generated at build time by ReadTheDocs and should not be committedTesting: Verified locally with
make html— docs build successfully and all previously missing classes are now rendered.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.