docs: add 'make:docs/reference' npm script to @dfinity/authentication (…

…dfinity#310) * add make docs * authentiation build makes docs/reference, and gitignore the output
ninegua · Mar 19, 2021 · 08ff6d3 · 08ff6d3
1 parent ae7be45
commit 08ff6d3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/packages/authentication/.gitignore b/packages/authentication/.gitignore
@@ -5,6 +5,9 @@ dist/
 **/*.js.map
 **/*.d.ts
 
+# generated docs
+/docs/reference
+
 # Cannot ignore .d.ts files in types/
 !types/**/*.d.ts
 

diff --git a/packages/authentication/package.json b/packages/authentication/package.json
@@ -4,11 +4,12 @@
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",
   "scripts": {
-    "build": "tsc -b && tsc -p tsconfig-cjs.json",
+    "build": "tsc -b && tsc -p tsconfig-cjs.json && npm run make:docs/reference",
     "bundle": "npm run build",
     "ci": "npm run prettier && npm run lint && npm run test",
     "lint": "eslint 'src' --ext '.js,.jsx,.ts,.tsx'",
     "lint:fix": "npm run lint -- --fix",
+    "make:docs/reference": "typedoc src/index.ts --out docs/reference",
     "prettier": "prettier --check \"src/**/*.ts\"",
     "prettier:write": "npm run prettier -- --write",
     "test": "jest --verbose --detectOpenHandles"
@@ -40,6 +41,7 @@
     "text-encoding": "^0.7.0",
     "ts-jest": "^24.2.0",
     "tslint": "^5.20.0",
+    "typedoc": "^0.20.32",
     "typescript": "^3.6.3",
     "whatwg-fetch": "^3.0.0"
   }