Skip to content

Commit 32b563b

Browse files
authored
docs(packages): fix aws client link in globals.html (#2259)
1 parent 4f9f4a7 commit 32b563b

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

packages/core-packages-documentation-generator/src/sdk-index-link-client.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
import { isAbsolute, join, relative, resolve, sep } from "path";
2-
import { BindOption } from "typedoc";
2+
import { BindOption, ProjectReflection, Reflection } from "typedoc";
33
import { Component, RendererComponent } from "typedoc/dist/lib/output/components";
44
import { PageEvent } from "typedoc/dist/lib/output/events";
55
import { NavigationItem } from "typedoc/dist/lib/output/models/NavigationItem";
66

7+
const isClientModel = (model: Reflection | undefined) => model?.sources[0]?.fileName.startsWith(`clients${sep}`);
8+
79
const PROJECT_ROOT = join(__dirname, "..", "..", "..", "..");
810
@Component({ name: "SdkIndexLinkClientPlugin" })
911
export class SdkIndexLinkClientPlugin extends RendererComponent {
@@ -46,6 +48,15 @@ export class SdkIndexLinkClientPlugin extends RendererComponent {
4648
if (page.model._skipRendering) {
4749
page.preventDefault();
4850
}
51+
52+
// Update the client doc link int globals.html
53+
if (page.filename.endsWith("globals.html")) {
54+
(page.model as ProjectReflection).children.filter(isClientModel).forEach((clientModel) => {
55+
const clientName = clientModel.sources[0].fileName.split(sep)[1];
56+
const clientDocDir = clientDocsPattern.replace(/{{CLIENT}}/g, clientName);
57+
clientModel.url = join(clientDocDir, "index.html");
58+
});
59+
}
4960
}
5061

5162
/**
@@ -89,6 +100,6 @@ export class SdkIndexLinkClientPlugin extends RendererComponent {
89100
}
90101

91102
private isClient(item: NavigationItem): boolean {
92-
return item?.reflection?.sources[0].fileName.startsWith(`clients${sep}`);
103+
return isClientModel(item?.reflection);
93104
}
94105
}

0 commit comments

Comments
 (0)