refactor: Incorporate JSDoc into the deploy job

Author: d3xter666

.github/workflows/deploy-vitepress-docs.yaml

@@ -54,19 +54,18 @@ jobs:
             - name: generate CLI doc
               working-directory: packages/documentation
               run: npm run generate-cli-doc
-            - name: Build jsdoc
-              working-directory: packages/documentation
-              run: npm run jsdoc-generate
             - name: Build vitepress build
               working-directory: packages/documentation
               run: |
-                cd packages/documentation
                 # The base output
                 npm run build:vitepress -- --base="/${{ github.event.repository.name }}/${DOC_VERSION}/"
                 npm run build:assets -- ./dist
                 # The alias output
                 npm run build:vitepress -- --base="/${{ github.event.repository.name }}/${DOC_ALIAS}/" --outDir="dist-${DOC_ALIAS}"
                 npm run build:assets -- ./dist-${DOC_ALIAS}
+            - name: Build jsdoc
+              working-directory: packages/documentation
+              run: npm run jsdoc-generate
             # TODO: Skip for now deployment of the schema until we do a Schema Version 5 release
             # - name: Build Schema
             #   run: |
@@ -87,15 +86,14 @@ jobs:
 
                   # Main version route
                   cp -R ./packages/documentation/dist ./gh-pages/${DOC_VERSION}/
-                  cp -R ./site/api ./gh-pages/${DOC_VERSION}/api
 
                   # Alias route. E.g., next, latest, stable, etc.
                   # For vitepress must be a copy with different config, not a symlink
                   cp -R ./packages/documentation/dist-${DOC_ALIAS} ./gh-pages/${DOC_ALIAS}/
                   # Symlink the api docs to avoid duplication
                   ln -s ../${DOC_VERSION}/api ./gh-pages/${DOC_ALIAS}/api
 
-                  cp ./scripts/resources/custom404.html ./gh-pages/404.html
+                  cp ./packages/documentation/scripts/resources/custom404.html ./gh-pages/404.html
             - name: Publish Docs
               run: |
                   cd ./gh-pages

packages/documentation/jsdoc/jsdoc.json

@@ -0,0 +1,71 @@
+{
+	"tags": {
+		"allowUnknownTags": false
+	},
+	"source": {
+		"include": ["jsdoc/index.md"],
+		"exclude": [
+			"node_modules/@ui5/builder/lib/lbt/utils/JSTokenizer.js",
+			"node_modules/@ui5/builder/lib/processors/jsdoc/lib/ui5/plugin.js",
+			"node_modules/@ui5/builder/lib/processors/jsdoc/lib/ui5/template/publish.js",
+			"node_modules/@ui5/builder/lib/processors/jsdoc/lib/ui5/template/utils/versionUtil.js"
+		],
+		"includePattern": "node_modules/@ui5/[^\/]*/(lib/.+|index)\\.js$",
+		"excludePattern": "node_modules/@ui5/.*/node_modules/@ui5"
+	},
+	"plugins": [
+		"jsdoc/jsdoc-plugin.cjs"
+	],
+	"opts": {
+		"encoding": "utf8",
+		"destination": "dist/api/",
+		"recurse": true,
+		"verbose": true,
+		"access": "public"
+	},
+	"templates": {
+		"cleverLinks": false,
+		"monospaceLinks": false,
+		"default": {
+			"useLongnameInNav": true,
+			"layoutFile": "jsdoc/templates/layout.tmpl",
+			"staticFiles": {
+				"include": ["jsdoc/templates/custom.css"]
+			}
+		}
+	},
+	"openGraph": {
+		"title": "UI5 CLI - API Reference",
+		"type": "website",
+		"image": "https://ui5.github.io/cli/v4/images/UI5_logo_wide.png",
+		"site_name": "UI5 CLI - API Reference",
+		"url": "https://ui5.github.io/cli/v4/"
+	},
+	"docdash": {
+		"sectionOrder": [
+			"Modules",
+			"Namespaces",
+			"Classes",
+			"Externals",
+			"Events",
+			"Mixins",
+			"Tutorials",
+			"Interfaces"
+		],
+		"meta": {
+			"title": "UI5 CLI - API Reference",
+			"description": "UI5 CLI - API Reference",
+			"keyword": "openui5 sapui5 ui5 build development tool api reference"
+		},
+		"search": true,
+		"wrap": true,
+		"menu": {
+			"GitHub": {
+				"href": "https://github.com/UI5/cli",
+				"target": "_blank",
+				"class": "menu-item",
+				"id": "github_link"
+			}
+		}
+	}
+}