build: Generate and publish API docs

.github/workflows/apidocs.yml

@@ -0,0 +1,24 @@
+name: Generate API docs
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.1
+
+      - name: Generate docs
+        run: |
+          npm install
+          npm run apidocs
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@4.1.1
+        with:
+          branch: gh-pages
+          folder: apidocs

.gitignore

@@ -1,3 +1,4 @@
+apidocs
 dist
 node_modules
 coverage

.npmignore

@@ -1,3 +1,4 @@
+apidocs
 coverage
 examples
 test

package.json

@@ -6,6 +6,7 @@
   "repository": "aholstenson/atvik",
   "scripts": {
     "test": "jest",
+    "apidocs": "typedoc",
     "ci": "npm run coverage && npm run lint",
     "coverage": "jest --coverage",
     "lint": "eslint --ext .ts,.tsx .",
@@ -43,7 +44,7 @@
     "jest-config": "^27.0.4",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.0.3",
+    "typedoc": "^0.21.0-beta.2",
     "typescript": "^4.3.2"
-  },
-  "dependencies": {}
+  }
 }

tsconfig.json

@@ -21,5 +21,10 @@
 	},
 	"include": [
 		"src"
-	]
+	],
+	"typedocOptions": {
+		"entryPoints": [ "src/index.ts" ],
+		"out": "apidocs",
+		"excludePrivate": true
+	}
 }