Add typedoc

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
nextcloud-libraries · Dec 18, 2019 · ef1b709 · ef1b709
1 parent 8da6421
commit ef1b709
Show file tree

Hide file tree

Showing 3 changed files with 194 additions and 3 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -3,3 +3,15 @@ node_js: node
 branches:
   only:
   - master
+script:
+  - npm run build
+  - npm run test
+  - npm run build:doc
+deploy:
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  keep-history: true
+  local-dir: dist/doc
+  on:
+    branch: master
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "babel ./lib --out-dir dist --extensions '.ts,.tsx' --source-maps && tsc --emitDeclarationOnly",
+    "build:doc": "typedoc --out dist/doc lib && touch dist/doc/.nojekyll",
     "check-types": "tsc",
     "dev": "babel ./lib --out-dir dist --extensions '.ts,.tsx' --watch",
     "test": "jest",
@@ -34,6 +35,7 @@
     "babel-jest": "^24.9.0",
     "babel-plugin-inline-json-import": "^0.3.2",
     "jest": "^24.9.0",
+    "typedoc": "^0.15.5",
     "typescript": "^3.6.3"
   },
   "browserslist": [