build: update typedoc build configuration and recipes

Jaysukh-409 · Nov 20, 2024 · de6ab34 · de6ab34
1 parent a5cea01
commit de6ab34
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 10 deletions.
diff --git a/etc/typedoc/.typedoc.json b/etc/typedoc/.typedoc.json
@@ -0,0 +1 @@
+{}
diff --git a/etc/typedoc/tsconfig.json b/etc/typedoc/tsconfig.json
@@ -0,0 +1,43 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": false,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "alwaysStrict": true,
+    "baseUrl": "lib/node_modules",
+    "checkJs": true,
+    "forceConsistentCasingInFileNames": true,
+    "keyofStringsOnly": false,
+    "lib": [
+      "es6"
+    ],
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "newLine": "lf",
+    "noEmit": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": false,
+    "noImplicitThis": true,
+    "noStrictGenericChecks": false,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "paths": {},
+    "pretty": true,
+    "strictBindCallApply": true,
+    "strictFunctionTypes": true,
+    "strictNullChecks": true,
+    "suppressExcessPropertyErrors": false,
+    "suppressImplicitAnyIndexErrors": false,
+    "typeRoots": [ "." ],
+    "types": []
+  },
+  "include": [
+    "./../../lib/node_modules/**/docs/types/index.d.ts",
+    "./../../lib/node_modules/**/@stdlib/types/index.d.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}
diff --git a/tools/make/lib/docs/typedoc.mk b/tools/make/lib/docs/typedoc.mk
@@ -25,7 +25,7 @@ TYPEDOC ?= $(BIN_DIR)/typedoc
 TYPEDOC_CONF ?= $(CONFIG_DIR)/typedoc/.typedoc.json
 
 # Define the path to a TypeScript configuration file:
-TYPEDOC_TSCONFIG ?= $(ROOT_DIR)/tsconfig.json
+TYPEDOC_TSCONFIG ?= $(CONFIG_DIR)/typedoc/tsconfig.json
 
 # Define the output directory for TypeDoc:
 TYPEDOC_OUT ?= $(SRC_DOCS_DIR)/typedoc
@@ -44,32 +44,25 @@ TYPEDOC_HTML ?= $(TYPEDOC_HTML_OUT)/index.html
 
 # Define command-line options to be used when invoking the TypeDoc executable to generate HTML documentation:
 TYPEDOC_HTML_FLAGS ?= \
-	--mode modules \
-	--target es6 \
-	--module commonjs \
+	--options $(TYPEDOC_CONF) \
 	--tsconfig $(TYPEDOC_TSCONFIG) \
 	--excludeExternals \
 	--excludePrivate \
 	--excludeProtected \
-	--includeDeclarations \
 	--exclude '{**/*test*,**/test*.ts,**/*.js,**/*test.ts}' \
 	--name stdlib \
 	--theme $(CONFIG_DIR)/typedoc/theme/ \
 	--hideGenerator \
 	--readme $(CONFIG_DIR)/typedoc/index.md \
-	--gaID 'UA-105890493-1' \
 	--out $(TYPEDOC_HTML_OUT)
 
 # Define command-line options to be used when invoking the TypeDoc executable to generate TypeDoc JSON:
 TYPEDOC_JSON_FLAGS ?= \
-	--mode modules \
-	--target es6 \
-	--module commonjs \
+	--options $(TYPEDOC_CONF) \
 	--tsconfig $(TYPEDOC_TSCONFIG) \
 	--excludeExternals \
 	--excludePrivate \
 	--excludeProtected \
-	--includeDeclarations \
 	--exclude '{**/*test*,**/test*.ts,**/*.js,**/*test.ts}' \
 	--name stdlib \
 	--json $(TYPEDOC_JSON)