Idea-Studios/libgit2
2
0
Fork 0
mirror of https://github.com/libgit2/libgit2.git synced 2026-06-22 06:26:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: clean up old documentation

Browse Source 
Clean up the outdated documentation folder before re-generating it in
place. This accomodates a deleted API.
This commit is contained in:
Edward Thomson
2024-12-10 23:22:35 +00:00
parent ce01bb30fc
commit 0f1cb81a0c
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
script/api-docs/docs-generator.js
View File

@@ -1084,6 +1084,19 @@ async function produceDocumentationMetadata(version, apiData) {
await fs.writeFile(filename, JSON.stringify(apiData.info, null, 2) + "\n"); 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) { async function produceDocumentationForVersion(version, apiData) {
if (!options.force && await documentationIsUpToDateForVersion(version, apiData)) { if (!options.force && await documentationIsUpToDateForVersion(version, apiData)) {
if (options.verbose) { if (options.verbose) {
@@ -1097,6 +1110,8 @@ async function produceDocumentationForVersion(version, apiData) {
console.log(`Producing documentation for ${version}...`); console.log(`Producing documentation for ${version}...`);
} }
await cleanupOldDocumentation(version);
await produceDocumentationForApis(version, apiData); await produceDocumentationForApis(version, apiData);
for (const group in apiData['groups']) { for (const group in apiData['groups']) {