Generate Pulumi SDK docs - Python @v3.238.0#18982
Closed
pulumi-bot wants to merge 7 commits into
Closed
Conversation
Replaces the implicit "one shared sphinx docset spanning all packages" model with three independent per-package docsets. Each per-package workflow now produces output that depends only on its own package; a regen of one package no longer affects the rendered HTML of the others. Layout change: - tools/pydocgen/source/pulumi/ — own conf.py + index.rst - tools/pydocgen/source/pulumi_policy/ — own conf.py + index.rst - tools/pydocgen/source/pulumi_esc_sdk/ — own conf.py + index.rst Each conf.py displays the installed package version (via importlib.metadata.version) in the rendered docs' sidebar, so reference pages now indicate which release they correspond to. Falls back to "unknown" if the package isn't installed (e.g. local dev without pipenv). generate_python_docs.sh is simpler: pick the right source/<PACKAGE>/ dir and build directly to static-prebuilt/.../python/<PACKAGE>/. No temp dirs, no fabricated single-package toctree. Install only the target package (and pulumi where Policy needs it for autodoc). Adds a Hugo content stub at content/docs/reference/pkg/python/ that replaces the sphinx-generated unified parent index.html. Hugo runs after the static-prebuilt copy step in build-site.sh, so the new _index.md will override the orphaned sphinx index.html on the next deploy. This is a corollary of issue #18934 (Part 4 follow-up). Fixes a regression where PR #18980's preview site showed only the pulumi package without sibling-package sidebar links — the per-package builds were correctly producing isolated output, but the layout assumed a shared docset. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Three new cards under Reference for the ESC SDK across the three languages it ships: TypeScript (Node.js), Python, and Go. Mirrors the "Language SDKs" and "Policy SDKs" sections immediately above. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The dotnet and python per-language reference pages have _index.md landing pages listing their available SDKs, but nodejs did not, so /docs/reference/pkg/nodejs/ surfaced no ESC SDK link. Mirror the python/_index.md structure with the three Node.js SDKs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Hugo's dev server doesn't serve content from static-prebuilt/, so SDK
reference pages 404 in dev mode. This trips up anyone trying to preview
their changes to /docs/reference/pkg/... locally without realizing they
need the build + serve-static combo.
Adds explicit notes to:
* README.md — expands the make serve / make build / make serve-static
entries in the Makefile helpers list to call out the gap.
* BUILD-AND-DEPLOY.md — adds a callout in the Local Development section.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The Reference > SDKs section of the left nav is defined in config/_default/menus.yml as a hand-curated list, separate from the content frontmatter menus. It previously had 5 Language SDK entries + 2 Policy SDK entries but no ESC SDK entries — so the ESC SDKs were missing from the navigation even though they appeared in the Reference home page's card layout. Adds three new entries under `reference-sdks`: * TypeScript ESC SDK * Python ESC SDK * Go ESC SDK Also fixes the Go ESC SDK URL on the Reference home page card to match: `https://pkg.go.dev/github.com/pulumi/esc-sdk/sdk/go` is the actual package documentation; the shorter `/sdk` URL pkg.go.dev only renders the module root with "this package is not in the latest version". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The verbose "TypeScript (Node.js)" label was inherited from the Reference home page card; the left-nav already shows three TypeScript-related SDK entries (Pulumi, Policy, ESC), so just "TypeScript" reads cleaner here. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Collaborator
Author
|
Your site preview for commit 740c0c9 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-18982-740c0c99.s3-website.us-west-2.amazonaws.com |
Collaborator
Author
Lighthouse Performance ReportCommit: 740c0c9 | Metric definitions
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated PR generated by the Pulumi SDK docs - Python workflow (
.github/workflows/pulumi-sdk-python-docs.yml).Workflow run: https://github.com/pulumi/docs/actions/runs/25836164978