one-observability-demo/typedoc.json at main · aws-samples/one-observability-demo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
  "entryPoints": ["src/cdk/lib"],
  "entryPointStrategy": "expand",
  "out": "./docs-site/docs/api",
  "plugin": ["typedoc-plugin-markdown"],
  "theme": "markdown",
  "entryFileName": "index",
  "mergeReadme": true,
  "name": "One Observability Workshop",
  "includeVersion": true,
  "excludePrivate": true,
  "excludeProtected": false,
  "excludeExternals": true,
  "readme": "none",
  "exclude": ["**/*.d.ts", "**/node_modules/**", "**/cdk.out/**", "**/lib/constructs/index.ts", "**/lib/stages/index.ts", "**/lib/utils/index.ts"],
  "gitRevision": "main",
  "hideGenerator": true,
  "sort": ["source-order"],
  "kindSortOrder": [
    "Document",
    "Project",
    "Module",
    "Namespace",
    "Enum",
    "EnumMember",
    "Class",
    "Interface",
    "TypeAlias",
    "Constructor",
    "Property",
    "Variable",
    "Function",
    "Accessor",
    "Method",
    "Parameter",
    "TypeParameter",
    "TypeLiteral",
    "CallSignature",
    "ConstructorSignature",
    "IndexSignature",
    "GetSignature",
    "SetSignature"
  ],
  "categorizeByGroup": true,
  "defaultCategory": "Other",
  "categoryOrder": [
    "Constructs",
    "Interfaces",
    "Types",
    "Functions",
    "Variables",
    "*"
  ],
  "tsconfig": "src/cdk/tsconfig.json",
  "treatWarningsAsErrors": false,
  "validation": {
    "notExported": false,
    "invalidLink": false,
    "notDocumented": false
  },
  "blockTags": ["@optional", "@extends", "@param", "@returns", "@throws", "@see", "@example", "@deprecated", "@since", "@author", "@default"]
}