Add TypeScript SDK API reference docs via sphinx-js - #70812
Draft
jason810496 wants to merge 1 commit into
Draft
Conversation
phanikumv
reviewed
Jul 31, 2026
Comment on lines
+38
to
+39
| if (part.kind !== "text" && part.kind !== "code") { | ||
| parts[i] = { kind: "text", text: part.text ?? "" }; |
Contributor
There was a problem hiding this comment.
Suggested change
| if (part.kind !== "text" && part.kind !== "code") { | |
| parts[i] = { kind: "text", text: part.text ?? "" }; | |
| if (part.kind !== "text" && part.kind !== "code") { | |
| parts[i] = { kind: "code", text: "`" + (part.text ?? "") + "`" }; | |
| } |
Contributor
There was a problem hiding this comment.
Lets emit a markdown-style code part instead, so identifiers render as literals, skip the spellchecker, and cover it without wordlist churn
The spellcheck failure on getVariableOrThrow comes from this flatten turning {@link getVariableOrThrow} tags into plain text that `sphinxcontrib-spelling reads as prose...
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?