Skip to content

Commit

Permalink
fix: use typedoc config to avoid accidental inheritance (#1287)
Browse files Browse the repository at this point in the history
Each of our `tsconfig.json` inherits the root `tsconfig.json`. This root
config currently contains the typedoc configuration too, including
`endPointStrategy: "packages"`.

This leads to each package in the repo having its own root-level typedoc
config, which is causing typedoc to fail right now.

By moving the config to a `typedoc.json` at the root, we can continue
inheriting `tsconfig.json` without accidentally inheriting the typedoc
config.
  • Loading branch information
43081j authored Oct 7, 2024
1 parent baa6fff commit 90decc8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
11 changes: 1 addition & 10 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,5 @@
"composite": true,
"skipLibCheck": true
},
"references": [{ "path": "packages/parse5/tsconfig.json" }],
"typedocOptions": {
"entryPoints": ["packages/*"],
"out": "docs/build",
"name": "parse5",
"readme": "README.md",
"emit": "docs",
"excludeInternal": true,
"entryPointStrategy": "packages"
}
"references": [{ "path": "packages/parse5/tsconfig.json" }]
}
9 changes: 9 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"entryPoints": ["packages/*"],
"out": "docs/build",
"name": "parse5",
"readme": "README.md",
"emit": "docs",
"excludeInternal": true,
"entryPointStrategy": "packages"
}

0 comments on commit 90decc8

Please sign in to comment.