Skip to content

Commit 50d1cbf

Browse files
committed
docs: improve typedocs config to finally make some sense
1 parent ed3f993 commit 50d1cbf

File tree

1 file changed

+84
-15
lines changed

1 file changed

+84
-15
lines changed

typedoc.json

Lines changed: 84 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,87 @@
22
"name": "contentful-management.js",
33
"entryPoints": [
44
"lib/index.ts",
5-
// "lib/contentful-management.ts",
6-
// "lib/plain/plain-client.ts",
5+
"lib/create-contentful-api.ts",
6+
"lib/plain/plain-client.ts",
7+
"lib/plain/checks.ts",
78
// "lib/plain/wrappers/wrap.ts",
8-
// "lib/contentful-management.ts",
99
// "lib/create-adapter.ts",
10-
// "lib/create-contentful-api.ts",
1110
// "lib/entities/app-action.ts",
12-
// "lib/entities/environment-template-installation.ts"
11+
// "lib/entities/environment-template-installation.ts",
12+
"lib/entities/access-token.ts",
13+
"lib/entities/api-key.ts",
14+
"lib/entities/app-access-token.ts",
15+
"lib/entities/app-action-call.ts",
16+
"lib/entities/app-action.ts",
17+
"lib/entities/app-bundle.ts",
18+
"lib/entities/app-definition.ts",
19+
"lib/entities/app-details.ts",
20+
"lib/entities/app-event-subscription.ts",
21+
"lib/entities/app-installation.ts",
22+
"lib/entities/app-key.ts",
23+
"lib/entities/app-signed-request.ts",
24+
"lib/entities/app-signing-secret.ts",
25+
"lib/entities/app-upload.ts",
26+
"lib/entities/asset-key.ts",
27+
"lib/entities/asset.ts",
28+
"lib/entities/bulk-action.ts",
29+
"lib/entities/comment.ts",
30+
"lib/entities/concept-scheme.ts",
31+
"lib/entities/concept.ts",
32+
"lib/entities/content-type-fields.ts",
33+
"lib/entities/content-type.ts",
34+
"lib/entities/editor-interface.ts",
35+
"lib/entities/entry.ts",
36+
"lib/entities/environment-alias.ts",
37+
"lib/entities/environment-template-installation.ts",
38+
"lib/entities/environment-template.ts",
39+
"lib/entities/environment.ts",
40+
"lib/entities/extension.ts",
41+
"lib/entities/field-type.ts",
42+
"lib/entities/function-log.ts",
43+
"lib/entities/function.ts",
44+
"lib/entities/locale.ts",
45+
"lib/entities/oauth-application.ts",
46+
"lib/entities/organization-invitation.ts",
47+
"lib/entities/organization-membership.ts",
48+
"lib/entities/organization.ts",
49+
"lib/entities/personal-access-token.ts",
50+
"lib/entities/preview-api-key.ts",
51+
"lib/entities/release-action.ts",
52+
"lib/entities/release.ts",
53+
"lib/entities/resource-provider.ts",
54+
"lib/entities/resource-type.ts",
55+
"lib/entities/resource.ts",
56+
"lib/entities/role.ts",
57+
"lib/entities/scheduled-action.ts",
58+
"lib/entities/snapshot.ts",
59+
"lib/entities/space-member.ts",
60+
"lib/entities/space-membership.ts",
61+
"lib/entities/space.ts",
62+
"lib/entities/tag.ts",
63+
"lib/entities/task.ts",
64+
"lib/entities/team-membership.ts",
65+
"lib/entities/team-space-membership.ts",
66+
"lib/entities/team.ts",
67+
"lib/entities/ui-config.ts",
68+
"lib/entities/upload-credential.ts",
69+
"lib/entities/upload.ts",
70+
"lib/entities/usage.ts",
71+
"lib/entities/user-ui-config.ts",
72+
"lib/entities/user.ts",
73+
"lib/entities/utils.ts",
74+
"lib/entities/webhook.ts",
75+
"lib/entities/widget-parameters.ts",
76+
"lib/entities/workflow-definition.ts",
77+
"lib/entities/workflow.ts",
78+
"lib/entities/workflows-changelog-entry.ts"
1379
],
1480
"out": "out",
1581
"includeVersion": true,
16-
// "categorizeByGroup": true,
17-
// "categoryOrder": ["Core", "Clients", "Entities", "Utilities", "*"],
18-
"categoryOrder": ["createClient", "ClientParams", "ContentType", "Entry", "*"],
19-
// "groupOrder": ["Variables", "Functions", "*"],
82+
"categorizeByGroup": false,
83+
"categoryOrder": ["Core", "Plain Client", "Legacy Client", "Entities", "*"],
84+
"defaultCategory": "Other",
2085
"kindSortOrder": [
21-
"Reference",
2286
"Project",
2387
"Module",
2488
"Namespace",
@@ -31,6 +95,7 @@
3195
"Interface",
3296
"TypeAlias",
3397
"Variable",
98+
"Reference",
3499
"Accessor",
35100
"Method",
36101
"Parameter",
@@ -42,16 +107,20 @@
42107
"GetSignature",
43108
"SetSignature"
44109
],
110+
"groupOrder": ["Functions", "Interfaces", "Modules", "*"],
45111
"sortEntryPoints": false,
46112
"readme": "README.md",
47113
"excludePrivate": false,
48114
"excludeInternal": false,
49115
"excludeProtected": false,
50116
"treatWarningsAsErrors": false,
51117
"sort": ["source-order"],
52-
"plugin": [
53-
"typedoc-plugin-missing-exports",
54-
"typedoc-github-theme"
55-
],
118+
"plugin": ["typedoc-plugin-missing-exports", "typedoc-github-theme"],
56119
"hideGenerator": true,
57-
}
120+
"includeHierarchySummary": true,
121+
"navigation": {
122+
"includeGroups": false,
123+
"includeCategories": true,
124+
"includeFolders": false
125+
}
126+
}

0 commit comments

Comments
 (0)