-
Notifications
You must be signed in to change notification settings - Fork 206
Update typedoc #1041
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update typedoc #1041
Conversation
A live preview of this PR will be available at the URL(s) below. https://pr1041-9e72d17---lit-dev-5ftespv5na-uc.a.run.app/ |
So the Check API data in sync approach no longer works with [email protected] because the output isn't stable. There's a |
Somehow the |
Can we just delete the |
Maybe? If we don't use that to generate the docs. I'll try. |
@aomarks I didn't realize we were already pruning so many properties. I added |
@aomarks that worked! |
Right now the import locations are broken. They're rendering as: import { LitElement } from ''; fwiw, I was able to get some labs/contexts docs rendering as a follow-on. |
I'm doing this upgrade as a first step to try to get closer to API docs for labs packages like context, and because it'll likely be necessary at some point with TypeScript updates. TypeDoc 0.23 seems to have some better monorepo support.
There were some breaking changes that I think I got through. I looked through some API pages, but not all, and they seem fine so far. Will look at more soon.
The built JSON files are quite different, so they're going to be hard to review. I do wonder if we want stop regenerating the lit-html-1 and lit-element-2 data files so that we don't have to worry about changes to typedoc being incompatible with older jsdoc comment styles or older TypeScript source.