From 0f1cb81a0c277e76389509d3bb7a83fca8858f4d Mon Sep 17 00:00:00 2001
From: Edward Thomson <ethomson@edwardthomson.com>
Date: Tue, 10 Dec 2024 23:22:35 +0000
Subject: [PATCH] Documentation: clean up old documentation

Clean up the outdated documentation folder before re-generating it in
place. This accomodates a deleted API.
---
 script/api-docs/docs-generator.js | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/script/api-docs/docs-generator.js b/script/api-docs/docs-generator.js
index 2670b8a3a..dcf25e573 100755
--- a/script/api-docs/docs-generator.js
+++ b/script/api-docs/docs-generator.js
@@ -1084,6 +1084,19 @@ async function produceDocumentationMetadata(version, apiData) {
     await fs.writeFile(filename, JSON.stringify(apiData.info, null, 2) + "\n");
 }
 
+async function cleanupOldDocumentation(version) {
+    const versionDir = `${outputPath}/${version}`;
+
+    for (const fn of await fs.readdir(versionDir)) {
+        if (fn === '.metadata') {
+            continue;
+        }
+
+        const path = `${versionDir}/${fn}`;
+        await fs.rm(path, { recursive: true });
+    }
+}
+
 async function produceDocumentationForVersion(version, apiData) {
     if (!options.force && await documentationIsUpToDateForVersion(version, apiData)) {
         if (options.verbose) {
@@ -1097,6 +1110,8 @@ async function produceDocumentationForVersion(version, apiData) {
         console.log(`Producing documentation for ${version}...`);
     }
 
+    await cleanupOldDocumentation(version);
+
     await produceDocumentationForApis(version, apiData);
 
     for (const group in apiData['groups']) {