Skip to content

Commit e22e5b2

Browse files
docs: ensure referenced types are included in typedoc site (electron#2960)
1 parent 827c3ea commit e22e5b2

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@
144144
"sinon-chai": "^3.6.0",
145145
"ts-node": "^10.0.0",
146146
"typedoc": "^0.22.15",
147+
"typedoc-plugin-missing-exports": "^1.0.0",
147148
"typedoc-plugin-rename-defaults": "^0.6.4",
148149
"typescript": "^4.6.3",
149150
"xvfb-maybe": "^0.2.1"

tools/gen-docs.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ import * as typedoc from 'typedoc';
1313
excludePrivate: true,
1414
excludeProtected: true,
1515
hideGenerator: true,
16-
plugin: ['typedoc-plugin-rename-defaults'],
16+
externalPattern: ['**/node_modules/@types/node/**'],
17+
plugin: ['typedoc-plugin-rename-defaults', 'typedoc-plugin-missing-exports'],
1718
});
1819

1920
const projReflection = typedocApp.convert();

yarn.lock

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9084,6 +9084,11 @@ typedarray-to-buffer@^3.1.5:
90849084
dependencies:
90859085
is-typedarray "^1.0.0"
90869086

9087+
typedoc-plugin-missing-exports@^1.0.0:
9088+
version "1.0.0"
9089+
resolved "https://registry.yarnpkg.com/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-1.0.0.tgz#7212a2cfaba7b48264df4b4110f3a5684b5c49a1"
9090+
integrity sha512-7s6znXnuAj1eD9KYPyzVzR1lBF5nwAY8IKccP5sdoO9crG4lpd16RoFpLsh2PccJM+I2NASpr0+/NMka6ThwVA==
9091+
90879092
typedoc-plugin-rename-defaults@^0.6.4:
90889093
version "0.6.4"
90899094
resolved "https://registry.yarnpkg.com/typedoc-plugin-rename-defaults/-/typedoc-plugin-rename-defaults-0.6.4.tgz#8019bbfdbb4616682a0af8ecf1e8f42d053d4a40"

0 commit comments

Comments
 (0)