Add TypeScript SDK API reference docs via sphinx-js - #70812
Open
jason810496 wants to merge 5 commits into
Open
Conversation
phanikumv
reviewed
Jul 31, 2026
jason810496
force-pushed
the
feature/ts-sdk/typescript-api-docs
branch
from
August 3, 2026 03:48
29a9a15 to
bc59b65
Compare
jason810496
marked this pull request as ready for review
August 3, 2026 08:29
jason810496
requested review from
amoghrajesh,
ashb,
bugraoz93,
choo121600,
ephraimbuddy,
gopidesupavan,
jedcunningham,
jscheffl,
potiuk and
vatsrahul1001
as code owners
August 3, 2026 08:29
Contributor
|
Quickest fix: git fetch upstream main && git rebase upstream/main
rm uv.lock && uv lock
git add uv.lock && git rebase --continue
git push --force-with-leaseAutomated nudge — ignore if you're not ready to rebase. This comment is updated in place on future |
jason810496
marked this pull request as draft
August 4, 2026 10:14
jason810496
force-pushed
the
feature/ts-sdk/typescript-api-docs
branch
from
August 4, 2026 12:42
0c39519 to
8c185dc
Compare
jason810496
marked this pull request as ready for review
August 5, 2026 02:05
jason810496
force-pushed
the
feature/ts-sdk/typescript-api-docs
branch
2 times, most recently
from
August 5, 2026 06:40
de67e1a to
bfebf21
Compare
Wrapping the referenced identifier in backticks makes it render as an inline literal and keeps sphinxcontrib-spelling from treating the identifier as prose, so the build no longer fails on names like getVariableOrThrow and the spelling wordlist stays clean.
Packages whose inventory cannot be fetched (typically brand-new docs packages not yet published) are built first precisely so that their objects.inv exists for every other package's intersphinx mapping. The Sphinx spelling builder never writes objects.inv, so a spellcheck-only pre-build left the inventory missing, every other package failed inventory resolution, and the retry logic rebuilt the whole docs set in up to three additional full passes - the --spellcheck-only CI job ran 2h27m while the equivalent --docs-only job finished in 32m.
"abortable" is not in the spellcheck dictionary and docs prose should not need a wordlist entry for a phrasing that can simply be avoided.
publish-docs resolves every package's version up front via get_package_version_possibly_from_stable_txt, which knew nothing about ts-sdk, so the "Publish documentation and validate versions" CI job failed with "Unsupported package: ts-sdk". Fall back to the version in ts-sdk/package.json the same way task-sdk falls back to its source version, matching what DocsPublisher already does.
jason810496
force-pushed
the
feature/ts-sdk/typescript-api-docs
branch
from
August 6, 2026 03:26
bfebf21 to
c42a3ef
Compare
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
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.
Why
The upcoming TS-SDK package has a public API that is annotated with JSDoc/TSDoc but has no rendered API reference. This adds one, built with pyodide/sphinx-js (TypeDoc-backed) and wired into the existing
build-docsandpublish-docspipelines next totask-sdk.How
ts-sdk/docs/Sphinx tree that mirrorstask-sdk/docs/, swappingautoapiforsphinx-jssince the source is TypeScript.src/index.ts) is fed to TypeDoc, so its reachability analysis documents exactly the public surface and excludes the generated/internal modules.ts-sdk/docs/package.json+package-lock.jsonand pinned deliberately:es2023target, sots-sdk/docs/tsconfig.jsonis a standalone config forcinges2022for the parse-only pass.ts-sdk/docs/sphinxJsConfig.mjsflattens TSDoc{@link}inline tags to plain text, which sphinx-js cannot otherwise render.AirflowDocsBuilderinstalls the pinned toolchain withnpm ci(reproducible) on demand before the sphinx run, sobuild-docs ts-sdkworks wherever Node is available (already present in the docs CI image). A failed install returns aDocBuildErrorfor that package rather than aborting the whole run.sphinx-jspullsparsimoniousand requirescattrs < 25, souv.lockdowngradescattrs26.1.0 to 24.1.3 (sphinx-js declarescattrsas a dependency).Verification
Notes for reviewers
0.25pin is a version cap forced by sphinx-js 5.0.3. Per the repo convention for capped dependencies, this warrants a GitHub tracking issue (to bump TypeDoc/TypeScript once sphinx-js supports TypeDoc 0.28).Was generative AI tooling used to co-author this PR?