Skip to content

Commit eb992bb

Browse files
committed
chore: add readme file to typedoc config
1 parent 5b7a913 commit eb992bb

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

scripts/generate-clients/copy-to-clients.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ const copyToClients = async (sourceDir, destinationDir) => {
127127
...mergeManifest(packageManifest, destManifest),
128128
typedoc: {
129129
entryPoint: "src/index.ts",
130+
readmeFile: "README.md",
130131
},
131132
homepage: `https://github.com/aws/aws-sdk-js-v3/tree/main/clients/${clientName}`,
132133
repository: {
@@ -145,6 +146,8 @@ const copyToClients = async (sourceDir, destinationDir) => {
145146
const typedocJson = {
146147
extends: ["../../typedoc.client.json"],
147148
entryPoints: ["src/index.ts"],
149+
out: "docs",
150+
readme: "README.md",
148151
};
149152
writeFileSync(destSubPath, JSON.stringify(typedocJson, null, 2).concat(`\n`));
150153
} else if (overWritableSubs.includes(packageSub) || !existsSync(destSubPath)) {

typedoc.client.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
"hideGenerator": true,
66
"skipErrorChecking": true,
77
"excludeInternal": true,
8-
"readme": "README.md",
98
"plugin": ["@aws-sdk/core-theme-documentation-generator", "@aws-sdk/service-client-documentation-generator"],
109
"defaultServiceSuffix": "AWS SDK for JavaScript v3",
1110
"theme": "sdk",

0 commit comments

Comments
 (0)