Remove README from documentation api section (#34)

david-yz-liu · May 24, 2024 · 5c223d1 · 5c223d1
1 parent f13e248
commit 5c223d1
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 83 deletions.
diff --git a/docs/docs/99-api/index.md b/docs/docs/99-api/index.md
diff --git a/docs/docs/99-api/modules.md b/docs/docs/99-api/modules.md
@@ -32,4 +32,4 @@ the produced canvas
 
 #### Defined in
 
-[user_functions.ts:29](https://github.com/david-yz-liu/memory-viz/blob/4d72b15/memory-viz/src/user_functions.ts#L29)
+[user_functions.ts:29](https://github.com/david-yz-liu/memory-viz/blob/442d14c/memory-viz/src/user_functions.ts#L29)
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -143,6 +143,7 @@ const config = {
             // Plugin / TypeDoc options
             {
                 entryPoints: ["../memory-viz/src/user_functions.ts"],
+                readme: "none",
                 tsconfig: "../tsconfig.json",
                 out: "99-api",
             },
Original file line number	Diff line number	Diff line change
Expand Up		@@ -32,4 +32,4 @@ the produced canvas

		#### Defined in

		[user_functions.ts:29](https://github.com/david-yz-liu/memory-viz/blob/4d72b15/memory-viz/src/user_functions.ts#L29)
		[user_functions.ts:29](https://github.com/david-yz-liu/memory-viz/blob/442d14c/memory-viz/src/user_functions.ts#L29)