Revamp Sagemaker doc (#1706)

* initial PR

* nit

* inference-toolkit

* toctree

* miss

* fix

* clea toctree and port previous content to new section

* miss

* get a index.md page

* a

* add section in how to

* change get started section

* dlc faq

* previous guides

* structure how to

* nit

* first batch of notebooks

* test

* bedrock quickstart

* Update how SageMaker docs are built

- Update the GitHub Actions
- Move the `docs/sagemaker` docs into the `source` directory
- Add `docs/sagemaker/Makefile` and `docs/sagemaker/scripts` for
automatically generating the examples and updating the `_toctree.yml`
- Most of those things are ported from
https://github.com/huggingface/Google-Cloud-Containers

* Fix typos

* nits bedrock

* jumpstart guide

* test

* typos

* dlc guide

* nit

* florent's review

* nit

---------

Co-authored-by: Alvaro Bartolome <[email protected]>

Author: pagezyhf

.github/workflows/sagemaker_build_documentation.yml

@@ -1,11 +1,13 @@
-name: Build sagemaker documentation
+name: Build SageMaker Documentation
 
 on:
   push:
-    paths:
-      - "docs/sagemaker/**"
     branches:
       - main
+      - doc-builder*
+    paths:
+      - docs/sagemaker/**
+      - .github/workflows/sagemaker_build_documentation.yaml
 
 jobs:
    build:
@@ -14,7 +16,9 @@ jobs:
       commit_sha: ${{ github.sha }}
       package: hub-docs
       package_name: sagemaker
-      path_to_docs: hub-docs/docs/sagemaker/
+      path_to_docs: hub-docs/docs/sagemaker/source
       additional_args: --not_python_module
+      pre_command: cd hub-docs/docs/sagemaker && make docs
     secrets:
+      token: ${{ secrets.HUGGINGFACE_PUSH }}
       hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}

.github/workflows/sagemaker_build_pr_documentation.yml

@@ -1,9 +1,10 @@
-name: Build sagemaker PR Documentation
+name: Build SageMaker PR Documentation
 
 on:
   pull_request:
     paths:
-      - "docs/sagemaker/**"
+      - docs/sagemaker/**
+      - .github/workflows/sagemaker_build_pr_documentation.yaml
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -17,5 +18,6 @@ jobs:
       pr_number: ${{ github.event.number }}
       package: hub-docs
       package_name: sagemaker
-      path_to_docs: hub-docs/docs/sagemaker/
+      path_to_docs: hub-docs/docs/sagemaker/source
       additional_args: --not_python_module
+      pre_command: cd hub-docs/docs/sagemaker && make docs

.github/workflows/sagemaker_delete_doc_comment.yml

@@ -1,10 +1,9 @@
-name: Delete sagemaker doc comment trigger
+name: Delete SageMaker PR Documentation Comment
 
 on:
   pull_request:
     types: [ closed ]
 
-
 jobs:
   delete:
     uses: huggingface/doc-builder/.github/workflows/delete_doc_comment_trigger.yml@main

.github/workflows/sagemaker_upload_pr_documentation.yml

@@ -1,8 +1,8 @@
-name: Upload sagemaker PR Documentation
+name: Upload SageMaker PR Documentation
 
 on:
   workflow_run:
-    workflows: ["Build sagemaker PR Documentation"]
+    workflows: ["Build SageMaker PR Documentation"]
     types:
       - completed
 
@@ -13,4 +13,4 @@ jobs:
       package_name: sagemaker
     secrets:
       hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
-      comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }}
+      comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }}

docs/sagemaker/Makefile

@@ -0,0 +1,34 @@
+.PHONY: docs clean help
+
+docs: clean
+	@echo "Processing README.md files from examples/gke, examples/cloud-run, and examples/vertex-ai..."
+	@mkdir -p source/examples
+	@echo "Converting Jupyter Notebooks to MDX..."
+	@doc-builder notebook-to-mdx notebooks/sagemaker-sdk/
+	@echo "Auto-generating example files for documentation..."
+	@python scripts/auto-generate-examples.py
+	@echo "Cleaning up generated Markdown Notebook files..."
+	@find notebooks/sagemaker-sdk -name "sagemaker-notebook.md" -type f -delete
+	@echo "Generating YAML tree structure and appending to _toctree.yml..."
+	@python scripts/auto-update-toctree.py
+	@echo "YAML tree structure appended to docs/source/_toctree.yml"
+	@echo "Documentation setup complete."
+
+clean:
+	@echo "Cleaning up generated documentation..."
+	@rm -rf source/examples
+	@awk '/^# GENERATED CONTENT DO NOT EDIT!/,/^# END GENERATED CONTENT/{next} {print}' source/_toctree.yml > source/_toctree.yml.tmp && mv source/_toctree.yml.tmp source/_toctree.yml
+	@echo "Cleaning up generated Markdown Notebook files (if any)..."
+	@find notebooks/sagemaker-sdk -name "sagemaker-notebook.md" -type f -delete
+	@echo "Cleanup complete."
+
+serve:
+	@echo "Serving documentation via doc-builder"
+	doc-builder preview sagemaker source/ --not_python_module
+
+help:
+	@echo "Usage:"
+	@echo "  make docs   - Auto-generate the examples for the docs"
+	@echo "  make clean  - Remove the auto-generated docs"
+	@echo "  make help   - Display this help message"
+