Skip to content

Commit 59acfb7

Browse files
committed
Added typedoc configuration to easily generate API reference docs.
1 parent 7fd7088 commit 59acfb7

File tree

3 files changed

+35
-3
lines changed

3 files changed

+35
-3
lines changed

package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
"lint": "eslint **/*.ts",
1717
"lint:fix": "eslint --fix **/*.ts",
1818
"format": "prettier **/*.ts --write",
19-
"test": "vitest"
19+
"test": "vitest",
20+
"docs": "typedoc"
2021
},
2122
"workspaces": [
2223
"core",
@@ -32,6 +33,11 @@
3233
"gts": "^5.3.1",
3334
"prettier": "^3.6.2",
3435
"prettier-plugin-organize-imports": "^4.3.0",
36+
"typedoc": "^0.28.14",
37+
"typedoc-material-theme": "^1.4.0",
38+
"typedoc-theme-fresh": "^0.2.1",
39+
"typedoc-github-theme": "^ 0.3.1",
40+
"varvara-typedoc-theme": "^0.3.8",
3541
"typescript": "^5.9.2",
3642
"typescript-eslint": "^8.46.0",
3743
"vitest": "^3.2.4"

tsconfig.json

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@
66
"lib": ["ES2022", "DOM"],
77
"moduleResolution": "nodenext",
88
"esModuleInterop": true,
9-
"skipLibCheck": true
10-
}
9+
"skipLibCheck": true,
10+
"rootDir": "."
11+
},
12+
"exclude": [
13+
"node_modules",
14+
"dist",
15+
"coverage",
16+
"**/*_test.ts",
17+
"**/test",
18+
"core/test",
19+
"dev/test"
20+
]
1121
}

typedoc.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"$schema": "https://typedoc.org/schema.json",
3+
"entryPoints": ["./core/src/index.ts"],
4+
"exclude": ["**/*_test.ts", "**/test"],
5+
"out": "api-reference/typescript/",
6+
"name": "ADK for TypeScript: API Reference",
7+
"readme": "none",
8+
"excludePrivate": true,
9+
"tsconfig": "./tsconfig.json",
10+
11+
"plugin": [
12+
"typedoc-theme-fresh"
13+
],
14+
"theme": "fresh",
15+
"excludeExternals": true
16+
}

0 commit comments

Comments
 (0)