Skip to content

Comments

chore(docs): Increase Node memory limit for docs#467

Merged
fb55 merged 1 commit intomasterfrom
fix-typedoc
Mar 18, 2022
Merged

chore(docs): Increase Node memory limit for docs#467
fb55 merged 1 commit intomasterfrom
fix-typedoc

Conversation

@fb55
Copy link
Collaborator

@fb55 fb55 commented Mar 18, 2022

typedoc builds successfully on my local ARM Mac, but runs out of memory on GitHub Actions. I suspect that the limit needs to be bumped slightly to make things go for now.

This is a known issue: TypeStrong/typedoc#1606

This PR also includes a config change of typedoc to stop emitting source code, and to exclude functions marked as @internal. Plus, ESLint will now ignore built docs.

`typedoc` builds successfully on my local ARM Mac, but runs out of memory on GitHub Actions. I suspect that the limit needs to be bumped slightly to make things go for now.

This is a consequence of TypeStrong/typedoc#1606

Also includes a config change of typedoc to stop emitting source code, and to exclude functions marked as `@internal`. Plus, ESLint will now ignore built docs.
@fb55 fb55 merged commit 7a191ad into master Mar 18, 2022
@fb55 fb55 deleted the fix-typedoc branch March 18, 2022 14:30
"out": "docs/build",
"name": "parse5",
"readme": "README.md",
"emit": "docs",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: This is the default

Copy link
Collaborator Author

@fb55 fb55 Mar 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I didn't realise — thanks for flagging.

This PR fixed our builds by the way, as can be seen in https://github.com/inikulin/parse5/commits/gh-pages. One way I was able to replicate the out of memory issue locally is to reduce the memory limit of Node using --max-old-space-size=1024.

jmbpwtw pushed a commit to jmbpwtw/parse5 that referenced this pull request Feb 16, 2023
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