Merge pull request #321 from edgardmessias/typedoc

docs: Added automated documentation

.github/workflows/nightly.yml

@@ -29,6 +29,9 @@ jobs:
       - name: Build NPM package
         run: npm pack && mv venom-bot-*.tgz venom-bot-nightly.tgz
 
+      - name: Build API-Docs
+        run: npm run generate-api-docs
+
       - name: Generate Changelog
         id: generate_changelog
         run: |
@@ -59,5 +62,6 @@ jobs:
           prerelease: true
           files: >
             venom-bot-nightly.tgz
+            api-docs/
           gzip: folders
           allow_override: true

.github/workflows/publish.yml

@@ -55,3 +55,14 @@ jobs:
           body: ${{ steps.generate_changelog.outputs.changelog }}
           draft: false
           prerelease: false
+
+      - name: Build API-Docs
+        run: npm run generate-api-docs
+        continue-on-error: true
+
+      - name: Deploy API-Docs
+        uses: peaceiris/actions-gh-pages@v3
+        continue-on-error: true
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./api-docs

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 *.tgz
 006.png
+api-docs
 app.js
 app.ts
 app2.js

.npmignore

@@ -1,5 +1,6 @@
 .*
 *.tgz
+api-docs
 app.js
 app.ts
 app2.js

package.json

@@ -17,6 +17,7 @@
     "changelog:update": "conventional-changelog -p angular -i CHANGELOG.md -s",
     "clean": "rimraf session dist",
     "commit": "cz",
+    "generate-api-docs": "typedoc",
     "lint": "npx eslint -c .eslintrc.js --ext .ts src",
     "prepublish": "npm run clean && npm run build",
     "release": "release-it",
@@ -84,7 +85,7 @@
     "release-it": "^14.2.0",
     "rimraf": "^3.0.2",
     "ts-loader": "^8.0.9",
-    "typedoc": "^0.19.2",
+    "typedoc": "^0.20.0-beta.8",
     "typescript": "^4.0.5",
     "webpack": "^4.44.2",
     "webpack-cli": "^4.1.0"

typedoc.json

@@ -0,0 +1,9 @@
+{
+  "disableSources": true,
+  "entryPoints": "src/index.ts",
+  "excludeExternals": true,
+  "excludePrivate": true,
+  "includeVersion": true,
+  "out": "api-docs",
+  "theme": "default"
+}