add typedoc generation for corev1Api

kopernic-pl · Aug 22, 2019 · d8ce9e9 · d8ce9e9
1 parent 0a0dcbf
commit d8ce9e9
Show file tree

Hide file tree

Showing 5 changed files with 155 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,5 @@ examples/package-lock.json
 kubernetes-client-node-*.tgz
 **/*.swp
 .idea/
+docs/*
+.DS_Store
diff --git a/README.md b/README.md
@@ -119,6 +119,16 @@ npm install
 npm run generate
 ```
 
+## Documentation
+
+Documentation is generated via typedoc:
+
+```
+npm run docs
+```
+
+To view the generated documentation, open `docs/index.html`
+
 ## Formatting
 
 Run `npm run format` or install an editor plugin like https://github.com/prettier/prettier-vscode and https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -21,7 +21,8 @@
     "generate": "./generate-client.sh",
     "watch": "tsc --watch",
     "test": "nyc mocha",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "docs": "typedoc src/gen/api/coreV1Api.ts"
   },
   "nyc": {
     "include": [
@@ -85,6 +86,7 @@
     "ts-mockito": "^2.3.1",
     "ts-node": "^8.2.0",
     "tslint": "^5.17.0",
+    "typedoc": "^0.15.0",
     "typescript": "^3.1.3"
   },
   "bugs": {

diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "mode": "file",
+  "out": "docs",
+  "excludeExternals": true
+}