Skip to content

Commit 5973d7d

Browse files
committed
docs: Move JSDoc build to /packages/documentation/jsdoc
+ Remove jsdoc-workspace artifacts
1 parent e0b185d commit 5973d7d

File tree

8 files changed

+9
-83
lines changed

8 files changed

+9
-83
lines changed

jsdoc-workspace.json

Lines changed: 0 additions & 65 deletions
This file was deleted.

package.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,8 @@
2828
"lint:commit": "commitlint",
2929
"unit": "npm run unit --workspaces",
3030
"coverage": "npm run coverage --workspaces",
31-
"jsdoc": "npm run jsdoc-generate && open-cli site/api/index.html",
32-
"jsdoc-generate": "node ./scripts/isWorkspace.js && npm run jsdoc-generate-workspace || npm run jsdoc-generate-local",
33-
"jsdoc-generate-local": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
34-
"jsdoc-generate-workspace": "jsdoc -c ./jsdoc-workspace.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ../ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
31+
"jsdoc": "npm run jsdoc-generate && open-cli packages/documentation/jsdoc/site/api/index.html",
32+
"jsdoc-generate": "jsdoc -c packages/documentation/jsdoc/jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
3533
"schema-generate": "node ./scripts/buildSchema.js ui5",
3634
"schema-workspace-generate": "node ./scripts/buildSchema.js ui5-workspace",
3735
"generate-cli-doc": "node ./scripts/generateCliDoc.js",
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
![UI5 icon](https://raw.githubusercontent.com/UI5/cli/main/docs/images/UI5_logo_wide.png)
2+
13
# UI5 CLI API Reference
24

35
## Support

jsdoc-plugin.cjs renamed to packages/documentation/jsdoc/jsdoc-plugin.cjs

File renamed without changes.

jsdoc.json renamed to packages/documentation/jsdoc/jsdoc.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"allowUnknownTags": false
44
},
55
"source": {
6-
"include": ["packages/documentation/docs/indexJsdoc.md"],
6+
"include": ["packages/documentation/jsdoc/index.md"],
77
"exclude": [
88
"node_modules/@ui5/builder/lib/lbt/utils/JSTokenizer.js",
99
"node_modules/@ui5/builder/lib/processors/jsdoc/lib/ui5/plugin.js",
@@ -14,11 +14,11 @@
1414
"excludePattern": "node_modules/@ui5/.*/node_modules/@ui5"
1515
},
1616
"plugins": [
17-
"./jsdoc-plugin.cjs"
17+
"packages/documentation/jsdoc/jsdoc-plugin.cjs"
1818
],
1919
"opts": {
2020
"encoding": "utf8",
21-
"destination": "site/api/",
21+
"destination": "packages/documentation/jsdoc/site/api/",
2222
"recurse": true,
2323
"verbose": true,
2424
"access": "public"
@@ -28,9 +28,9 @@
2828
"monospaceLinks": false,
2929
"default": {
3030
"useLongnameInNav": true,
31-
"layoutFile": "lib/jsdoc/plugin/template/layout.tmpl",
31+
"layoutFile": "packages/documentation/jsdoc/templates/layout.tmpl",
3232
"staticFiles": {
33-
"include": ["lib/jsdoc/plugin/template/custom.css"]
33+
"include": ["packages/documentation/jsdoc/templates/custom.css"]
3434
}
3535
}
3636
},
File renamed without changes.
File renamed without changes.

scripts/isWorkspace.js

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)