feat: Add typedoc references generation (#515)

aws-amplify · Feb 4, 2025 · af98dd4 · af98dd4
1 parent 35d1456
commit af98dd4
Show file tree

Hide file tree

Showing 5 changed files with 193 additions and 2 deletions.
diff --git a/.changeset/four-lies-cross.md b/.changeset/four-lies-cross.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ lib-esm
 dist
 node_modules
 tsconfig.tsbuildinfo
+typedocs/reference.json
 
 .turbo
 .idea

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -45,6 +45,7 @@
     "test": "turbo run test && npm run test:scripts && npm run e2e-exports",
     "test:scripts": "npx jest scripts/",
     "turbo": "turbo",
+    "typedoc": "typedoc",
     "vend": "npm run start:npm-proxy && npm run publish:local"
   },
   "devDependencies": {
@@ -80,6 +81,7 @@
     "ts-jest": "^29.1.1",
     "tsx": "^4.8.2",
     "turbo": "^1.10.14",
+    "typedoc": "^0.27.6",
     "typescript": "^5.1.6",
     "verdaccio": "^6.0.2"
   },

diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,16 @@
+{
+	"name": "Amplify Data API Documentation",
+	"entryPointStrategy": "packages",
+    "entryPoints": [
+		"packages/data-schema",
+		"packages/data-schema-types",
+	],
+	"json": "typedocs/reference.json",
+	"sortEntryPoints": false,
+	"includeVersion": false,
+	"hideGenerator": true,
+	"navigationLinks": {
+	},
+	"plugin": [
+	],
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ lib-esm @@
     dist
     node_modules
     tsconfig.tsbuildinfo
+    typedocs/reference.json
     .turbo
     .idea
@@ Expand Down @@