Skip to content

Fix API reference docs to auto-discover all public modules#5737

Merged
mollyheamazon merged 3 commits intoaws:masterfrom
mollyheamazon:v3-docs-update
Apr 8, 2026
Merged

Fix API reference docs to auto-discover all public modules#5737
mollyheamazon merged 3 commits intoaws:masterfrom
mollyheamazon:v3-docs-update

Conversation

@mollyheamazon
Copy link
Copy Markdown
Contributor

@mollyheamazon mollyheamazon commented Apr 8, 2026

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:

  • Replaced manual .. automodule:: entries in all 4 API RST files (sagemaker_core, sagemaker_train, sagemaker_serve, sagemaker_mlops) with .. autosummary:: :recursive:
  • Sphinx now auto-discovers all public modules, so new modules are documented automatically without any manual RST updates
  • Updated conf.py to suppress internal/non-user-facing modules (telemetry, tools, container_drivers, runtime_environment, model_server, detector, validations) and suppress known duplicate cross-reference warnings caused by shared class names across modules
  • Added docs/api/generated/ to .gitignore — this directory is generated at build time by ReadTheDocs and should not be committed

Testing: 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.

@mollyheamazon mollyheamazon changed the base branch from v3-docs-update to master April 8, 2026 19:48
@mollyheamazon
Copy link
Copy Markdown
Contributor Author

aviruthen
aviruthen previously approved these changes Apr 8, 2026
@mollyheamazon mollyheamazon merged commit 91ca011 into aws:master Apr 8, 2026
16 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants