UI changes for documentation

Author: adishaa

.gitignore

@@ -16,6 +16,7 @@ __pycache__/
 /.mypy_cache
 
 /doc/_apidoc/
+doc/_build/
 /build
 
 /sagemaker-hyperpod/build

doc/_static/custom.css

@@ -0,0 +1,53 @@
+/* Custom styles for SageMaker HyperPod documentation */
+
+/* Adjust logo size and alignment */
+.navbar-brand img {
+    max-height: 40px;
+    width: auto;
+    margin-right: 10px;
+    vertical-align: middle;
+}
+
+.navbar-brand .title {
+    font-weight: 800;
+    color: #111827;
+}
+
+/* Ensure logo container doesn't force wrapping */
+.navbar-brand-box {
+    width: auto;
+    flex-shrink: 0;
+}
+
+/* Header styling */
+header {
+    background-color: white;
+    box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05); /* shadow-sm */
+    position: sticky;
+    top: 0;
+    z-index: 50;
+}
+
+/* Preserving your existing typography */
+h1 {
+    font-size: 1.875rem;      /* text-3xl */
+    font-weight: 700;         /* font-bold */
+    color: #111827;           /* text-gray-900 */
+}
+
+h2 {
+    font-size: 1.5rem;        /* text-2xl */
+    font-weight: 700;         /* font-bold */
+    color: #111827;
+}
+
+h3 {
+    font-size: 1.25rem;
+    font-weight: 500;
+    color: #111827;
+}
+
+p {
+    font-size: 0.875rem;     /* Tailwind's text-sm */
+    color: #4b5563;          /* Tailwind's gray-600 */
+}

doc/conf.py

@@ -107,6 +107,7 @@ def get_version():
 html_theme = "sphinx_book_theme"
 html_theme_options = {
     "logo": {
+        "text": "SageMaker HyperPod<br>CLI and SDK",
         "image_light": "_static/image.png",
         "image_dark": "_static/image.png",
     },
@@ -116,9 +117,13 @@ def get_version():
     "use_edit_page_button": True,
     "path_to_docs": "doc",
     "show_navbar_depth": 2,
+    "use_fullscreen_button": False,
+    "use_download_button": False,
+    "home_page_in_toc": True
 }
 htmlhelp_basename = "{}doc".format(project)
-
+html_static_path = ["_static"]
+html_css_files = ["custom.css"]
 napoleon_use_rtype = False
 
 # nbsphinx configuration

doc/examples.md

@@ -0,0 +1,21 @@
+(examples)=
+
+# Example Notebooks
+
+## Training Example Notebooks
+
+For detailed examples of training with HyperPod, see:
+
+- [CLI Training Example](https://github.com/aws/sagemaker-hyperpod-cli/blob/main/examples/training/CLI/training-e2e-cli.ipynb)
+- [SDK Training Example](https://github.com/aws/sagemaker-hyperpod-cli/blob/main/examples/training/SDK/training_sdk_example.ipynb)
+
+## Inference Example Notebooks
+
+For detailed examples of inference with HyperPod, see:
+
+- [CLI Inference FSX Model Example](https://github.com/aws/sagemaker-hyperpod-cli/blob/main/examples/inference/CLI/inference-fsx-model-e2e-cli.ipynb)
+- [CLI Inference Jumpstart Model Example](https://github.com/aws/sagemaker-hyperpod-cli/blob/main/examples/inference/CLI/inference-jumpstart-e2e-cli.ipynb)
+- [CLI Inference S3 Model Example](https://github.com/aws/sagemaker-hyperpod-cli/blob/main/examples/inference/CLI/inference-s3-model-e2e-cli.ipynb)
+- [SDK Inference FSX Model Example](https://github.com/aws/sagemaker-hyperpod-cli/blob/main/examples/inference/SDK/inference-fsx-model-e2e.ipynb)
+- [SDK Inference Jumpstart Model Example](https://github.com/aws/sagemaker-hyperpod-cli/blob/main/examples/inference/SDK/inference-jumpstart-e2e.ipynb)
+- [SDK Inference S3 Model Example](https://github.com/aws/sagemaker-hyperpod-cli/blob/main/examples/inference/SDK/inference-s3-model-e2e.ipynb)

doc/getting_started.ipynb

@@ -1,6 +1,6 @@
 (hpcli_docs_mainpage)=
 
-# SageMaker HyperPod CLI and SDK Documentation
+# Overview
 
 ```{toctree}
 :hidden:
@@ -10,13 +10,14 @@ Installation <installation>
 Getting Started <getting_started>
 Training <training>
 Inference <inference>
+Example Notebooks <examples>
 API reference <_apidoc/modules>
 ```
 
 SageMaker HyperPod CLI and SDK provide a seamless way to manage distributed training and inference workloads on EKS-hosted SageMaker HyperPod clusters—without needing Kubernetes expertise. Use the powerful CLI to launch and monitor training jobs and endpoints, or leverage the Python SDK to do the same programmatically with minimal code, including support for JumpStart models, custom endpoints, and built-in monitoring.
 
 ::::{container}
-::::{grid}
+::::{grid} 1 2 4 4
 :gutter: 3
 
 :::{grid-item-card} Installation
@@ -47,6 +48,13 @@ Detailed guide on creating Pytorch training jobs
 Detailed guide on creating, invoking and monitoring endpoints
 :::
 
+:::{grid-item-card} Example Notebooks
+:link: examples
+:link-type: ref
+
+Notebooks that demonstrate end-to-end workflows
+:::
+
 ::::
 ::::