docs: typedoc for 3 packages

Agoric · Apr 12, 2024 · 02a1155 · 02a1155
1 parent cc9c394
commit 02a1155
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 0 deletions.
diff --git a/package.json b/package.json
@@ -10,6 +10,7 @@
   "type": "module",
   "packageManager": "yarn@1.22.19",
   "scripts": {
+    "docs": "typedoc --excludeInternal",
     "format": "yarn prettier --write packages",
     "lint": "yarn workspaces run lint",
     "test": "yarn workspaces run test"

diff --git a/packages/rpc/typedoc.json b/packages/rpc/typedoc.json
@@ -0,0 +1,8 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "index.ts",
+    ]
+}
diff --git a/packages/web-components/typedoc.json b/packages/web-components/typedoc.json
@@ -0,0 +1,8 @@
+{
+    "extends": [
+        "../../typedoc.base.json"
+    ],
+    "entryPoints": [
+        "index.js",
+    ]
+}
diff --git a/typedoc.base.json b/typedoc.base.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true
+}
diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,10 @@
+{
+  "entryPoints": [
+    "packages/*",
+  ],
+  "name": "API documentation of Agoric ui-kit",
+  "entryPointStrategy": "packages",
+  "out": "api-docs",
+  "includeVersion": true,
+  "logLevel": "Verbose"
+}