Trim the output of TypeDoc

realm · Jul 7, 2023 · 88c3c72 · 88c3c72
1 parent b245f90
commit 88c3c72
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/packages/realm-react/src/index.tsx b/packages/realm-react/src/index.tsx
@@ -209,6 +209,9 @@ export const useQuery = defaultContext.useQuery;
  */
 export const useObject = defaultContext.useObject;
 
+/*
+ * @ignore This will end up documenting all of Realm, which is documented elsewhere
+ */
 export { Realm };
 export * from "./AppProvider";
 export { useUser, UserProvider } from "./UserProvider";

diff --git a/packages/realm/typedoc.json b/packages/realm/typedoc.json
@@ -2,6 +2,9 @@
   "entryPoints": ["src/index.ts"],
   "tsconfig": "./tsconfig.json",
   "excludeInternal": true,
+  "excludePrivate": true,
+  "excludeReferences": true,
+  "excludeNotDocumented": true,
   "customCss": "../../typedoc/style.css",
   "media": "../../media",
   "name": "Realm JavaScript",