DOCUMENTATION: Better npm run doc, plus minor folder reorganization (#693)

This commit is contained in:
Snarling
2023-08-01 00:59:33 -04:00
committed by GitHub
parent e624db5238
commit 83b7c380ff
44 changed files with 40 additions and 30 deletions

View File

@@ -1,7 +1,7 @@
const fs = require("fs");
const files = [];
const docRoot = "./src/Documentation/ui/doc";
const docRoot = "./src/Documentation/doc";
const processDir = (dir) => {
console.log(dir);
for (const file of fs.readdirSync(dir)) {

21
tools/doc.sh Normal file
View File

@@ -0,0 +1,21 @@
#!/bin/bash
echo "Bundling ingame documentation..."
node tools/bundle-doc/index.js
echo ""
echo "Using API Extractor to generate mappings for Netscript API definitions..."
npx api-extractor run
echo ""
echo "Creating markdown from Netscript API mappings..."
npx api-documenter markdown
echo ""
echo "Running cleanup tasks..."
rm input/bitburner.api.json && rm -r input
# This git add is needed due to documenter using wrong line endings. Console spam discarded.
git add markdown/ 2> /dev/null && git add tsdoc-metadata.json 2> /dev/null
echo ""
echo "Documentation build completed."