Add esc-sdk generated docs (#13757)

* Add esc-sdk to doc generation * Add esc-sdk docs to menu * Add links to esc-sdk docs from sdk pages * Get python docs from latest versions * Add prebuilt static docs * Update other prebuilt python autogenerated docs
pulumi · Jan 8, 2025 · 5bac4a4 · 5bac4a4
1 parent 814d839
commit 5bac4a4
Show file tree

Hide file tree

Showing 51 changed files with 10,064 additions and 168 deletions.
diff --git a/config/_default/menus.yml b/config/_default/menus.yml
@@ -207,6 +207,28 @@ esc:
     weight: 2
     parent: esc-cli-commands
 
+
+# -------------------------------------
+# ESC SDKs Menu
+# -------------------------------------
+
+esc:
+  - name: SDK docs
+    parent: esc-typescript-sdk
+    url: /docs/reference/pkg/nodejs/pulumi/esc-sdk/
+    weight: 1
+    identifier: esc-typescript-sdk-docs
+  - name: SDK docs
+    parent: esc-python-sdk
+    url: /docs/reference/pkg/python/pulumi_esc_sdk/
+    weight: 1
+    identifier: esc-python-sdk-docs
+  - name: SDK docs
+    parent: esc-go-sdk
+    url: https://pkg.go.dev/github.com/pulumi/esc-sdk/sdk/go
+    weight: 1
+    identifier: esc-go-sdk-docs
+
 # -------------------------------------
 # IaC Languages & SDKs Menus
 # -------------------------------------

diff --git a/content/docs/esc/development/languages-sdks/go.md b/content/docs/esc/development/languages-sdks/go.md
@@ -6,7 +6,7 @@ meta_desc: This page provides an overview on how to use Pulumi ESC Go SDK.
 menu:
   esc:
     parent: esc-languages-sdks
-    identifier: go-sdk
+    identifier: esc-go-sdk
     weight: 3
 aliases:
   - /docs/esc/sdk/go/
@@ -170,3 +170,7 @@ func main() {
 
 {{% /choosable %}}
 {{< /chooser >}}
+
+## Documentation
+
+* [API Reference Documentation](https://pkg.go.dev/github.com/pulumi/esc-sdk/sdk/go)
diff --git a/content/docs/esc/development/languages-sdks/javascript.md b/content/docs/esc/development/languages-sdks/javascript.md
@@ -6,7 +6,7 @@ meta_desc: This page provides an overview on how to use Pulumi ESC TypeScript/Ja
 menu:
   esc:
     parent: esc-languages-sdks
-    identifier: typescript-sdk
+    identifier: esc-typescript-sdk
     weight: 1
 aliases:
   - /docs/esc/sdk/javascript/
@@ -153,3 +153,7 @@ async function main() {
 
 {{% /choosable %}}
 {{< /chooser >}}
+
+## Documentation
+
+* [API Reference Documentation](/docs/reference/pkg/nodejs/pulumi/esc-sdk/)
diff --git a/content/docs/esc/development/languages-sdks/python.md b/content/docs/esc/development/languages-sdks/python.md
@@ -6,7 +6,7 @@ meta_desc: This page provides an overview on how to use Pulumi ESC Python SDK.
 menu:
   esc:
     parent: esc-languages-sdks
-    identifier: python-sdk
+    identifier: esc-python-sdk
     weight: 2
 aliases:
   - /docs/esc/sdk/python/
@@ -136,3 +136,7 @@ for tag in tags.tags:
 
 {{% /choosable %}}
 {{< /chooser >}}
+
+## Documentation
+
+* [API Reference Documentation](/docs/reference/pkg/python/pulumi_esc_sdk/)
diff --git a/scripts/generate_python_docs.sh b/scripts/generate_python_docs.sh
@@ -7,6 +7,7 @@ PACKAGES=(
   "pulumi"
   "pulumi_policy"
   "pulumi_terraform"
+  "pulumi_esc_sdk"
 )
 
 OUTDIR="../../static-prebuilt/docs/reference/pkg/python"
@@ -20,7 +21,7 @@ pipenv run pip install sphinx-rtd-theme
 echo "Building all Python docs..."
 # Install each package.
 for PACKAGE in "${PACKAGES[@]}" ; do \
-    pipenv run pip install "${PACKAGE}"
+    pipenv run pip install --upgrade "${PACKAGE}"
 done
 
 rm -rf "$OUTDIR"

diff --git a/scripts/run_typedoc.sh b/scripts/run_typedoc.sh
@@ -78,6 +78,7 @@ REPOS=(
     "policy,index.ts,pulumi-policy,sdk/nodejs/policy"
     "pulumi,index.ts,pulumi/sdk/nodejs"
     "terraform,index.ts,pulumi-terraform,sdk/nodejs"
+    "esc-sdk,index.ts,esc-sdk/sdk/typescript/esc"
 )
 
 PIDS=()

diff --git a/scripts/update_repos.sh b/scripts/update_repos.sh
@@ -12,6 +12,7 @@ TOOLS_REPOS=(
     "pulumi-kubernetesx"
     "pulumi-policy"
     "pulumi-terraform"
+    "esc-sdk"
 )
 
 update_repo() {

diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/esc-sdk/.nojekyll b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/esc-sdk/.nojekyll
@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/esc-sdk/assets/highlight.css b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/esc-sdk/assets/highlight.css
@@ -0,0 +1,22 @@
+:root {
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --code-background: var(--dark-code-background);
+}
+
+pre, code { background: var(--code-background); }
diff --git a/static-prebuilt/docs/reference/pkg/nodejs/pulumi/esc-sdk/assets/icons.js b/static-prebuilt/docs/reference/pkg/nodejs/pulumi/esc-sdk/assets/icons.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.