Add labs/context package to generated API docs #1092
Closed
Conversation
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
This required changing the build setup to use our wireit. From a spot check this will need more work as some debug only symbols have crept into the documentation.
The cost does not seem worthwhile for fixing this and blocking progress on Lit.dev support for v3. Instead unblock by manually providing the transpiled JavaScript for the Mixin sample.
This is due to a breaking change in TypeDoc. Default `entryPointStrategy` was changed from `expand` to `resolve`. Fixed by explicitly setting the prior version.
This fixes the source file links.
Co-authored-by: Augustine Kim <[email protected]>
The most major change that impacts our documentation generation is the `Comment` node has been updated to be a list of partial text fragments. We instead used to use a first line `shortText`, and remainder in `text`. This commit "fakes" that setup by doing the processing manually.
For example see parameters in: /docs/api/ReactiveElement/#ReactiveElement.requestUpdate
Tested by checking `observedAttributes` docs and `updateComplete`
|
A live preview of this PR will be available at the URL(s) below. |
|
The API docs are weird here. It seems to be documenting every class/interface member as a top-level module export. |
|
Oh yeah that is weird. I'm currently working on updating TypeDoc yet again to the most recent version to try and fix some of this weirdness. |
4 tasks
|
Figured it out - but was easier to start fresh. |
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.
Recommend reviewing 1 PR at a time. Builds on #1090
This is a WIP - but I've made the PR early to show that it generates.