Fix typedoc generation #14802 #14820
Conversation
* Revert to versions/script usage that were known to work * Re-add tsconfig that was removed during the yarn -> npm migration * increase memory
|
I kind missed this one. |
| @@ -0,0 +1,253 @@ | |||
| { | |||
There was a problem hiding this comment.
This file used to be generated: https://github.com/eclipse-theia/theia/pull/14481/files#diff-21d974bacb2fdab12e4e74074940b9e74d897b70d163686bfbe5a7048f62d056. If we revive it, we need to revive the generation code, as well. However, I'm not sure treating the monorepo as a compilable artifact is proper. Is there another way we can configure what needs to be documented? How are the examples being filtered?
There was a problem hiding this comment.
The examples are filtered here: https://github.com/eclipse-theia/theia/blob/master/configs/typedoc.json.
I didn't set up the TypeDoc generation initially, I just updated it to be compatible with a more recent TypeScript version, so I can't answer all details. But I think TypeDoc needs a tsconfig to locate included files and dependencies and to interpret the code correctly: https://typedoc.org/documents/Options.Configuration.html.
I'm not sure if there are other ways to configure this or if an alternative approach would be simpler than the previous solution.
Why was this generation removed?
There was a problem hiding this comment.
Because we're no longer using it to compile the whole monorepo.
What it does
closes #14802
How to test
Check gh-pages/docs/next/index.html
Follow-ups
Currently, this pins
typedocto0.25.13, the same version used before the yarn -> npm migration.As far as I remember, this was necessary because
typedoc-plugin-external-module-mapstopped working with newer versions. We should check how updating to the latest version would be possible.Additionally, we should look into reducing memory usage, as we're getting close to the GitHub runner's memory limit.
Breaking changes
Attribution
Review checklist
Reminder for reviewers