Skip to content

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

Closed
wants to merge 11 commits into from
Closed

Update typedoc #1041

wants to merge 11 commits into from

Conversation

justinfagnani
Copy link
Contributor

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.

@justinfagnani justinfagnani requested a review from aomarks February 5, 2023 17:07
@github-actions
Copy link

github-actions bot commented Feb 5, 2023

@justinfagnani
Copy link
Contributor Author

So the Check API data in sync approach no longer works with [email protected] because the output isn't stable. There's a target property on a bunch of node that looks like an integer ID. If we want to make sure the file is roughly "the same" we'll have to do some custom processing. @aomarks

@justinfagnani
Copy link
Contributor Author

Somehow the directives/ page isn't being generated.

@aomarks
Copy link
Member

aomarks commented Feb 6, 2023

So the Check API data in sync approach no longer works with [email protected] because the output isn't stable. There's a target property on a bunch of node that looks like an integer ID. If we want to make sure the file is roughly "the same" we'll have to do some custom processing. @aomarks

Can we just delete the target property?

@justinfagnani
Copy link
Contributor Author

@aomarks

Can we just delete the target property?

Maybe? If we don't use that to generate the docs. I'll try.

@justinfagnani
Copy link
Contributor Author

@aomarks I didn't realize we were already pruning so many properties. I added 'target' to the list and we'll see if things render properly.

@justinfagnani
Copy link
Contributor Author

@aomarks that worked!

@justinfagnani
Copy link
Contributor Author

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.

@AndrewJakubowicz AndrewJakubowicz mentioned this pull request May 2, 2023
@AndrewJakubowicz
Copy link
Contributor

This is superseded by #1093 and also #1093.

Thank you for providing a great reference to build on!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants