From 6d1a56a15e0864ce1e83b259bc9964333503ff5a Mon Sep 17 00:00:00 2001 From: Shahin Saadati Date: Wed, 10 Dec 2025 14:33:32 -0800 Subject: [PATCH] feat: Configure TypeDoc for API documentation generation --- package.json | 3 +++ tsconfig.json | 14 ++++++++++++-- typedoc.json | 15 +++++++++++++++ 3 files changed, 30 insertions(+), 2 deletions(-) create mode 100644 typedoc.json diff --git a/package.json b/package.json index bca29e9..1a1d567 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "lint": "eslint **/*.ts", "lint:fix": "eslint --fix **/*.ts", "format": "prettier **/*.ts --write", + "docs": "typedoc", "test": "vitest" }, "workspaces": [ @@ -32,6 +33,8 @@ "gts": "^5.3.1", "prettier": "^3.6.2", "prettier-plugin-organize-imports": "^4.3.0", + "typedoc": "^0.28.14", + "typedoc-theme-fresh": "^0.2.1", "typescript": "^5.9.2", "typescript-eslint": "^8.46.0", "vitest": "^3.2.4" diff --git a/tsconfig.json b/tsconfig.json index f2cd297..9452e38 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -6,6 +6,16 @@ "lib": ["ES2022", "DOM"], "moduleResolution": "nodenext", "esModuleInterop": true, - "skipLibCheck": true - } + "skipLibCheck": true, + "rootDir": "." + }, + "exclude": [ + "node_modules", + "dist", + "coverage", + "**/*_test.ts", + "**/test", + "core/test", + "dev/test" + ] } diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..2323eb2 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,15 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPoints": ["./core/src/index.ts"], + "exclude": ["**/*_test.ts", "**/test"], + "out": "api-reference/typescript/", + "name": "ADK for TypeScript: API Reference", + "readme": "none", + "excludePrivate": true, + "tsconfig": "./tsconfig.json", + "plugin": [ + "typedoc-theme-fresh" + ], + "theme": "fresh", + "excludeExternals": true +} \ No newline at end of file