Skip to content

Commit de6ab34

Browse files
committed
build: update typedoc build configuration and recipes
1 parent a5cea01 commit de6ab34

File tree

3 files changed

+47
-10
lines changed

3 files changed

+47
-10
lines changed

etc/typedoc/.typedoc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

etc/typedoc/tsconfig.json

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"compilerOptions": {
3+
"allowJs": true,
4+
"allowSyntheticDefaultImports": false,
5+
"allowUnreachableCode": false,
6+
"allowUnusedLabels": false,
7+
"alwaysStrict": true,
8+
"baseUrl": "lib/node_modules",
9+
"checkJs": true,
10+
"forceConsistentCasingInFileNames": true,
11+
"keyofStringsOnly": false,
12+
"lib": [
13+
"es6"
14+
],
15+
"module": "commonjs",
16+
"moduleResolution": "node",
17+
"newLine": "lf",
18+
"noEmit": true,
19+
"noFallthroughCasesInSwitch": true,
20+
"noImplicitAny": true,
21+
"noImplicitReturns": false,
22+
"noImplicitThis": true,
23+
"noStrictGenericChecks": false,
24+
"noUnusedLocals": true,
25+
"noUnusedParameters": true,
26+
"paths": {},
27+
"pretty": true,
28+
"strictBindCallApply": true,
29+
"strictFunctionTypes": true,
30+
"strictNullChecks": true,
31+
"suppressExcessPropertyErrors": false,
32+
"suppressImplicitAnyIndexErrors": false,
33+
"typeRoots": [ "." ],
34+
"types": []
35+
},
36+
"include": [
37+
"./../../lib/node_modules/**/docs/types/index.d.ts",
38+
"./../../lib/node_modules/**/@stdlib/types/index.d.ts"
39+
],
40+
"exclude": [
41+
"node_modules"
42+
]
43+
}

tools/make/lib/docs/typedoc.mk

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ TYPEDOC ?= $(BIN_DIR)/typedoc
2525
TYPEDOC_CONF ?= $(CONFIG_DIR)/typedoc/.typedoc.json
2626

2727
# Define the path to a TypeScript configuration file:
28-
TYPEDOC_TSCONFIG ?= $(ROOT_DIR)/tsconfig.json
28+
TYPEDOC_TSCONFIG ?= $(CONFIG_DIR)/typedoc/tsconfig.json
2929

3030
# Define the output directory for TypeDoc:
3131
TYPEDOC_OUT ?= $(SRC_DOCS_DIR)/typedoc
@@ -44,32 +44,25 @@ TYPEDOC_HTML ?= $(TYPEDOC_HTML_OUT)/index.html
4444

4545
# Define command-line options to be used when invoking the TypeDoc executable to generate HTML documentation:
4646
TYPEDOC_HTML_FLAGS ?= \
47-
--mode modules \
48-
--target es6 \
49-
--module commonjs \
47+
--options $(TYPEDOC_CONF) \
5048
--tsconfig $(TYPEDOC_TSCONFIG) \
5149
--excludeExternals \
5250
--excludePrivate \
5351
--excludeProtected \
54-
--includeDeclarations \
5552
--exclude '{**/*test*,**/test*.ts,**/*.js,**/*test.ts}' \
5653
--name stdlib \
5754
--theme $(CONFIG_DIR)/typedoc/theme/ \
5855
--hideGenerator \
5956
--readme $(CONFIG_DIR)/typedoc/index.md \
60-
--gaID 'UA-105890493-1' \
6157
--out $(TYPEDOC_HTML_OUT)
6258

6359
# Define command-line options to be used when invoking the TypeDoc executable to generate TypeDoc JSON:
6460
TYPEDOC_JSON_FLAGS ?= \
65-
--mode modules \
66-
--target es6 \
67-
--module commonjs \
61+
--options $(TYPEDOC_CONF) \
6862
--tsconfig $(TYPEDOC_TSCONFIG) \
6963
--excludeExternals \
7064
--excludePrivate \
7165
--excludeProtected \
72-
--includeDeclarations \
7366
--exclude '{**/*test*,**/test*.ts,**/*.js,**/*test.ts}' \
7467
--name stdlib \
7568
--json $(TYPEDOC_JSON)

0 commit comments

Comments
 (0)