client-sdk/ts-web: Add typedoc

oasisprotocol · Sep 20, 2023 · f7fcb8b · f7fcb8b
1 parent 54f5df8
commit f7fcb8b
Show file tree

Hide file tree

Showing 9 changed files with 201 additions and 4 deletions.
diff --git a/client-sdk/ts-web/core/package.json b/client-sdk/ts-web/core/package.json
@@ -43,6 +43,7 @@
         "protobufjs-cli": "^1.1.2",
         "stream-browserify": "^3.0.0",
         "ts-jest": "^29.1.1",
+        "typedoc": "^0.25.1",
         "typescript": "^5.2.2",
         "webpack": "^5.88.2",
         "webpack-cli": "^5.1.4",

diff --git a/client-sdk/ts-web/core/tsconfig.json b/client-sdk/ts-web/core/tsconfig.json
@@ -10,5 +10,11 @@
     },
     "include": [
         "src/**/*"
-    ]
+    ],
+    "typedocOptions": {
+      "entryPoints": ["src/index.ts"],
+      "out": "doc",
+      "excludeInternal": true,
+      "excludePrivate": true
+    }
 }
diff --git a/client-sdk/ts-web/ext-utils/package.json b/client-sdk/ts-web/ext-utils/package.json
@@ -33,6 +33,7 @@
         "prettier": "^3.0.3",
         "process": "^0.11.10",
         "stream-browserify": "^3.0.0",
+        "typedoc": "^0.25.1",
         "typescript": "^5.2.2",
         "webpack": "^5.88.2",
         "webpack-cli": "^5.1.4",

diff --git a/client-sdk/ts-web/ext-utils/tsconfig.json b/client-sdk/ts-web/ext-utils/tsconfig.json
@@ -10,5 +10,11 @@
     },
     "include": [
         "src/**/*"
-    ]
+    ],
+    "typedocOptions": {
+      "entryPoints": ["src/index.ts"],
+      "out": "doc",
+      "excludeInternal": true,
+      "excludePrivate": true
+    }
 }
diff --git a/client-sdk/ts-web/package-lock.json b/client-sdk/ts-web/package-lock.json
diff --git a/client-sdk/ts-web/rt/package.json b/client-sdk/ts-web/rt/package.json
@@ -41,6 +41,7 @@
         "process": "^0.11.10",
         "stream-browserify": "^3.0.0",
         "ts-jest": "^29.1.1",
+        "typedoc": "^0.25.1",
         "typescript": "^5.2.2",
         "webpack": "^5.88.2",
         "webpack-cli": "^5.1.4",

diff --git a/client-sdk/ts-web/rt/tsconfig.json b/client-sdk/ts-web/rt/tsconfig.json
@@ -9,5 +9,11 @@
     },
     "include": [
         "src/**/*"
-    ]
+    ],
+    "typedocOptions": {
+      "entryPoints": ["src/index.ts"],
+      "out": "doc",
+      "excludeInternal": true,
+      "excludePrivate": true
+    }
 }
diff --git a/client-sdk/ts-web/signer-ledger/package.json b/client-sdk/ts-web/signer-ledger/package.json
@@ -30,6 +30,7 @@
         "prettier": "^3.0.3",
         "process": "^0.11.10",
         "stream-browserify": "^3.0.0",
+        "typedoc": "^0.25.1",
         "typescript": "^5.2.2",
         "webpack": "^5.88.2",
         "webpack-cli": "^5.1.4",

diff --git a/client-sdk/ts-web/signer-ledger/tsconfig.json b/client-sdk/ts-web/signer-ledger/tsconfig.json
@@ -10,5 +10,11 @@
     },
     "include": [
         "src/**/*"
-    ]
+    ],
+    "typedocOptions": {
+      "entryPoints": ["src/index.ts"],
+      "out": "doc",
+      "excludeInternal": true,
+      "excludePrivate": true
+    }
 }