Update typedoc and make associated documentation changes. (#275) (#277)

launchdarkly · Oct 25, 2022 · 887955f · 887955f
1 parent 9238a8c
commit 887955f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 13 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -22,7 +22,7 @@ html: prepare
 prepare:
 	cp ../package.json before-typedoc-package.json
 	cp ../package-lock.json before-typedoc-package-lock.json
-	cd .. && npm install "typedoc@<0.20.0"
+	cd .. && npm install "typedoc@0.23.17"
 	rm -rf build
 	mkdir build
 	@# Extract the whole module declaration from launchdarkly-js-sdk-common, then remove the first and last lines

diff --git a/docs/doc.md b/docs/doc.md
@@ -0,0 +1,7 @@
+
+This is the API reference for the LaunchDarkly SDK for browser JavaScript.
+
+In typical usage, you will call {@link initialize} once at startup time to obtain an instance of
+{@link LDClient}, which provides access to all of the SDK's functionality.
+
+For more information, see the [SDK reference guide](https://docs.launchdarkly.com/sdk/client-side/javascript).
diff --git a/docs/typedoc.js b/docs/typedoc.js
@@ -12,8 +12,7 @@ if (!version) {
 module.exports = {
   out: './build/html',
   name: 'LaunchDarkly JavaScript SDK (' + version + ')',
-  readme: 'none',                // don't add a home page with a copy of README.md
-  mode: 'file',                  // don't treat "typings.d.ts" itself as a parent module
-  includeDeclarations: true,     // allows it to process a .d.ts file instead of actual TS code
-  entryPoint: '"launchdarkly-js-client-sdk"'    // note extra quotes - workaround for a TypeDoc bug
+  readme: 'doc.md',
+  entryPointStrategy: 'resolve', // Allows us to specify the specific entrypoints.
+  entryPoints: ["./build/typings.d.ts"] // This is the updated version created by the makefile.
 };
diff --git a/typings.d.ts b/typings.d.ts
@@ -1,11 +1,4 @@
-/**
- * This is the API reference for the LaunchDarkly SDK for browser JavaScript.
- *
- * In typical usage, you will call [[initialize]] once at startup time to obtain an instance of
- * [[LDClient]], which provides access to all of the SDK's functionality.
- *
- * For more information, see the [SDK reference guide](https://docs.launchdarkly.com/sdk/client-side/javascript).
- */
+// Put top level documentation into docs/doc.md.
 declare module 'launchdarkly-js-client-sdk' {
 
 //// DOCBUILD-START-REPLACE  (see docs/Makefile)