feat(): experimental support for typedoc generation #17377
Closed
Conversation
This file contains 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
Run `npm run typedoc` to generate docs in `typedoc-docs` dir. I thought I'd take a few mins and set this up. It was _mostly_ straightforward, except: 1. Figuring out the "entry point" for each package was difficult until I realized `.js` entry points are assumed to be compiled, and thus require a `sourceMappingUrl` reference. IMO this is probably a bug in TypeDoc 2. The `sourceMappingUrl` must reference an external sourcemap file; not an inline source map. If it's an inline source map, the system tries to `fs.open` a large data-url. 3. The babel config does not control whether external sourcemaps are created; `@babel/cli` does. So I needed to change those. 4. Practically speaking, I don't see any drawback to external sourcemaps _yet_ 5. TypeDoc has poor support for cross-package type references in monorepos, and I had to add a plugin which implements a workaround 6. Per some suggestions in the docs, I modified the order of references in the root `tsconfig.json` to start with "the biggest one first" I didn't modify any types or docstrings anywhere.
boneskull
added
the
Documentation
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.
Run
npm run typedocto generate docs intypedoc-docsdir.I thought I'd take a few mins and set this up. It was mostly straightforward, except:
.jsentry points are assumed to be compiled, and thus require asourceMappingUrlreference. IMO this is probably a bug in TypeDocsourceMappingUrlmust reference an external sourcemap file; not an inline source map. If it's an inline source map, the system tries tofs.opena large data-url.@babel/clidoes. So I needed to change those.tsconfig.jsonto start with "the biggest one first"I didn't modify any types or docstrings anywhere.
The intent here is to show a proof-of-concept.