Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add esc-sdk generated docs #13757

Merged
merged 6 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions config/_default/menus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
# -------------------------------------
Expand Down
6 changes: 5 additions & 1 deletion content/docs/esc/development/languages-sdks/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -170,3 +170,7 @@ func main() {

{{% /choosable %}}
{{< /chooser >}}

## Documentation

* [API Reference Documentation](https://pkg.go.dev/github.com/pulumi/esc-sdk/sdk/go)
6 changes: 5 additions & 1 deletion content/docs/esc/development/languages-sdks/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -153,3 +153,7 @@ async function main() {

{{% /choosable %}}
{{< /chooser >}}

## Documentation

* [API Reference Documentation](/docs/reference/pkg/nodejs/pulumi/esc-sdk/)
6 changes: 5 additions & 1 deletion content/docs/esc/development/languages-sdks/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -136,3 +136,7 @@ for tag in tags.tags:

{{% /choosable %}}
{{< /chooser >}}

## Documentation

* [API Reference Documentation](/docs/reference/pkg/python/pulumi_esc_sdk/)
3 changes: 2 additions & 1 deletion scripts/generate_python_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ PACKAGES=(
"pulumi"
"pulumi_policy"
"pulumi_terraform"
"pulumi_esc_sdk"
)

OUTDIR="../../static-prebuilt/docs/reference/pkg/python"
Expand All @@ -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"
Expand Down
1 change: 1 addition & 0 deletions scripts/run_typedoc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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=()
Expand Down
1 change: 1 addition & 0 deletions scripts/update_repos.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ TOOLS_REPOS=(
"pulumi-kubernetesx"
"pulumi-policy"
"pulumi-terraform"
"esc-sdk"
)

update_repo() {
Expand Down
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.
Original file line number Diff line number Diff line change
@@ -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); }

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading