From b2f8b7d596f0597ee5de59de8aea8b8dccb2e735 Mon Sep 17 00:00:00 2001
From: Michael Kriese <michael.kriese@visualon.de>
Date: Tue, 22 Mar 2022 13:36:27 +0100
Subject: [PATCH] docs: fix wrong path for module description (#14758)
---
tools/docs/modules.ts | 26 --------------------------
tools/docs/utils.ts | 2 +-
tools/generate-docs.ts | 4 ----
3 files changed, 1 insertion(+), 31 deletions(-)
delete mode 100644 tools/docs/modules.ts
diff --git a/tools/docs/modules.ts b/tools/docs/modules.ts
deleted file mode 100644
index cc15d58d81..0000000000
--- a/tools/docs/modules.ts
+++ /dev/null
@@ -1,26 +0,0 @@
-// import shell from 'shelljs';
-
-// import { readFile, updateFile } from '../utils/index.js';
-// // import { getDisplayName, getNameWithUrl, replaceContent } from './utils.js';
-
-// const fileRe = /modules[/\\](.+?)\.md$/;
-// const titleRe = /^#(.+?)$/m;
-
-export async function generateModules(_root: string): Promise<void> {
- // for (const f of shell.ls('../usage/modules/*.md')) {
- // const [, tgt] = fileRe.exec(f);
-
- // let content = await readFile(f);
- // content = content.replace(
- // titleRe,
- // `---
- // title: $1
- // ---
- // `
- // );
-
- // await updateFile(`./docs/modules/${tgt}.md`, content);
- // }
-
- await Promise.resolve();
-}
diff --git a/tools/docs/utils.ts b/tools/docs/utils.ts
index 671a0f3f56..b015d8c929 100644
--- a/tools/docs/utils.ts
+++ b/tools/docs/utils.ts
@@ -61,7 +61,7 @@ export async function formatDescription(
type: string,
name: string
): Promise<string> {
- const content = await readFile(`lib/${type}/${name}/readme.md`);
+ const content = await readFile(`lib/modules/${type}/${name}/readme.md`);
if (!content) {
return '';
}
diff --git a/tools/generate-docs.ts b/tools/generate-docs.ts
index 4e23ebcf74..b4f4dd8d62 100644
--- a/tools/generate-docs.ts
+++ b/tools/generate-docs.ts
@@ -4,7 +4,6 @@ import { getProblems, logger } from '../lib/logger';
import { generateConfig } from './docs/config';
import { generateDatasources } from './docs/datasources';
import { generateManagers } from './docs/manager';
-import { generateModules } from './docs/modules';
import { generatePlatforms } from './docs/platforms';
import { generatePresets } from './docs/presets';
import { generateSchema } from './docs/schema';
@@ -36,9 +35,6 @@ process.on('unhandledRejection', (err) => {
return;
}
- logger.info('* modules');
- await generateModules(dist);
-
logger.info('* platforms');
await generatePlatforms(dist);
--
GitLab