From 199435f57e391a38d0cc76e8e80202723cde7681 Mon Sep 17 00:00:00 2001 From: Spiker985 <7829451+Spiker985@users.noreply.github.com> Date: Fri, 24 Feb 2023 22:28:50 -0500 Subject: [PATCH 1/3] Update js-docs and private-js-docs --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 45c9c7ed1..fff499dd3 100644 --- a/package.json +++ b/package.json @@ -273,8 +273,8 @@ "build:apm": "cd ppm && yarn install", "start": "electron --no-sandbox --enable-logging . -f", "dist": "node script/electron-builder.js", - "js-docs": "jsdoc2md ./src/**/*.js ./packages/**/*.js > ./docs/Pulsar-API-Documentation.md", - "private-js-docs": "jsdoc2md --private ./src/**/*.js ./packages/**/*.js > ./docs/Source-Code-Documentation.md" + "js-docs": "jsdoc2md --files src --configure docs/.jsdoc.json > ./docs/Pulsar-API-Documentation.md", + "private-js-docs": "jsdoc2md --private --files src --configure docs/.jsdoc.json > ./docs/Source-Code-Documentation.md" }, "devDependencies": { "@electron/notarize": "^1.2.3", From 56adb2e9e4b4e1fc341adef9c4dcce30d158a78d Mon Sep 17 00:00:00 2001 From: Spiker985 <7829451+Spiker985@users.noreply.github.com> Date: Fri, 24 Feb 2023 22:30:35 -0500 Subject: [PATCH 2/3] Add jsdoc config file - Gets passed from jsdoc2md to jsdoc --- docs/.jsdoc.json | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/.jsdoc.json diff --git a/docs/.jsdoc.json b/docs/.jsdoc.json new file mode 100644 index 000000000..fae020030 --- /dev/null +++ b/docs/.jsdoc.json @@ -0,0 +1,11 @@ +{ + "recurseDepth": 10, + "source": { + "include": ["src", "packages"], + "exclude": ["node_modules"], + "excludePattern": "((^|\\/|\\\\)_|node_modules)" + }, + "opts": { + "recurse": true + } +} From 0d3e202f0d73c723e1b3321c7c9e8d3014461541 Mon Sep 17 00:00:00 2001 From: Spiker985 <7829451+Spiker985@users.noreply.github.com> Date: Fri, 24 Feb 2023 22:31:44 -0500 Subject: [PATCH 3/3] Add manual run for Doc CI --- .github/workflows/documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 3be813d4e..e71f5fc29 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -3,6 +3,7 @@ name: Documentation on: push: branches: [ "master" ] + workflow_dispatch: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}