[INTERNAL] Add automatic generation of CLI documentation (#246)

.github/workflows/deploy-docs.yml

@@ -9,14 +9,17 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
     - uses: actions/checkout@v2
+    - name: Install npm dependencies
+      run: npm ci
+    - name: Update CLI Doc
+      run: npm run generate-cli-doc
     - name: Build mkdocs
       uses: docker://squidfunk/mkdocs-material:4.6.0
       with:
         args: build
     - name: Set /site ownership to current user
       run: sudo chown -R $(id -u):$(id -g) ./site
-    - name: Install npm dependencies
-      run: npm ci
+
     - name: Build JSDoc
       run: npm run jsdoc-generate
     - name: Build Schema

.gitignore

@@ -58,3 +58,6 @@ deploy_key
 test/tmp/
 jsdocs/
 site/
+
+# Custom files
+docs/pages/CLI.md

package.json

@@ -23,7 +23,8 @@
 		"jsdoc-generate": "node_modules/.bin/jsdoc -c ./jsdoc.json ./ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
 		"docs": "bash ./scripts/serveDocs.sh",
 		"docs-generate": "bash ./scripts/buildDocs.sh && open-cli http://localhost:8000 && ws --compress -d site",
-		"schema-generate": "node ./scripts/buildSchema.js"
+		"schema-generate": "node ./scripts/buildSchema.js",
+		"generate-cli-doc": "node ./scripts/generateCliDoc.js"
 	},
 	"repository": {
 		"type": "git",
@@ -44,6 +45,7 @@
 		"local-web-server": "^4.2.1",
 		"mkdirp": "^1.0.4",
 		"open-cli": "^6.0.1",
-		"traverse": "^0.6.6"
+		"traverse": "^0.6.6",
+		"handlebars": "^4.7.6"
 	}
 }

scripts/buildDocs.sh

@@ -5,5 +5,6 @@ cd "$(dirname -- "$0")/.."
 
 echo "Changed directory to $(pwd)"
 
+npm run generate-cli-doc
 docker run --rm -it -v $(pwd):/docs squidfunk/mkdocs-material:4.6.0 build
 npm run jsdoc-generate