From d542cab7a4824cd5bcf3abc0b28cb821176e124a Mon Sep 17 00:00:00 2001
From: Max Lynch <max@ionic.io>
Date: Fri, 24 Sep 2021 14:36:54 -0500
Subject: [PATCH] Ignore generated docs
---
.gitignore | 1 +
scripts/docs-json/index.ts | 4 +++-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore
index 0d912b64b..1cbd11abc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,7 @@ node_modules/
aot/
scripts/ionic-native-bower
scripts/docs-json/*.json
+scripts/docs-json/typedoc-docs
dist/
src/@ionic-native/plugins/**/ngx
*.d.ts
diff --git a/scripts/docs-json/index.ts b/scripts/docs-json/index.ts
index 8073916cc..25fa8becf 100644
--- a/scripts/docs-json/index.ts
+++ b/scripts/docs-json/index.ts
@@ -20,6 +20,7 @@ interface Plugin {
}
const rootDir = resolve(__dirname, '../..');
+const typedocDocsTmp = resolve(__dirname, 'typedoc-docs');
const typedocTmp = resolve(__dirname, 'typedoc.tmp.json');
const pluginsDir = resolve(rootDir, 'src/@ionic-native/plugins');
const typedoc = new Application();
@@ -42,7 +43,7 @@ async function run(pluginsDir: string) {
}
}
-async function generateTypedoc(root: string, outputPath = typedocTmp) {
+async function generateTypedoc(root: string, outputPath = typedocTmp, outputDocsPath = typedocDocsTmp) {
const pluginDirs = await fs.readdir(root);
const paths = pluginDirs.map(dir => resolve(root, dir, 'index.ts'));
typedoc.bootstrap({
@@ -55,6 +56,7 @@ async function generateTypedoc(root: string, outputPath = typedocTmp) {
});
const project = typedoc.converter.convert(typedoc.getEntryPoints() ?? []);
+ await typedoc.generateDocs(project, outputDocsPath);
await typedoc.generateJson(project, outputPath);
return fs.readJson(outputPath);