Skip to content

docs: add api-docs GitHub workflow for Python API reference#690

Open
twishabansal wants to merge 5 commits into
docs/api-ref-gen-scriptsfrom
docs/api-ref-workflow
Open

docs: add api-docs GitHub workflow for Python API reference#690
twishabansal wants to merge 5 commits into
docs/api-ref-gen-scriptsfrom
docs/api-ref-workflow

Conversation

@twishabansal

@twishabansal twishabansal commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary

Third PR in the API reference pipeline. Adds .github/workflows/api-docs.yml, which runs the PR #689 scripts and deploys to gh-pages, mirroring the Go SDK's api-docs.yml.

Commits split copy from edit: commit 1 copies the Go workflow verbatim. Follow-up commits make edits.

Tested in #691

@twishabansal twishabansal marked this pull request as ready for review June 22, 2026 09:38
@twishabansal twishabansal requested a review from a team as a code owner June 22, 2026 09:38
@twishabansal twishabansal added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jun 22, 2026
Use npm ci against the committed docs-site lockfile instead of npm install,
which re-resolved latest semver each run and could pull a broken upstream
patch into the deploy build.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do not merge Indicates a pull request not ready for merge, due to either quality or timing.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants