-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtypedoc.json
34 lines (34 loc) · 960 Bytes
/
typedoc.json
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
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["./src/v20170710.ts", "./src/index.ts"],
"out": "docs",
"sourceLinkTemplate": "https://github.com/bachman-dev/wanikani-api-types/blob/{gitRevision}/{path}#L{line}",
"cleanOutputDir": true,
"includeVersion": true,
"categorizeByGroup": false,
"categoryOrder": ["Base", "Collections", "Data", "Parameters", "Payloads", "Reports", "Requests", "Resources", "*"],
"navigation": {
"includeCategories": true
},
"sort": ["required-first", "alphabetical"],
"visibilityFilters": { "private": false },
"treatWarningsAsErrors": true,
"requiredToBeDocumented": [
"Enum",
"EnumMember",
"Variable",
"Function",
"Class",
"Interface",
"Property",
"Method",
"Accessor",
"TypeAlias"
],
"validation": {
"notDocumented": true,
"invalidLink": true,
"notExported": true
},
"intentionallyNotExported": ["Brand", "NumberRange"]
}