docs: add documentation with typedoc using github action (#370)

.github/workflows/docs.yml

@@ -0,0 +1,27 @@
+name: Docs
+on:
+  push:
+    branches:
+      - master
+jobs:
+  release:
+    runs-on: ubuntu-latest    
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+    - run: npm ci
+    - run: npm run docs
+    - run: touch docs/.nojekyll
+    - name: GitHub Pages
+      if: success()
+      uses: crazy-max/[email protected]
+      with:
+          target_branch: gh-pages
+          build_dir: docs
+          committer_name: googlemaps-bot
+          committer_email: [email protected]
+          commit_message: "chore: publish docs"
+          keep_history: true
+      env:
+        GITHUB_PAT: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }}
+

.gitignore

@@ -2,6 +2,7 @@
 logs
 *.log
 dist/
+docs/
 # Runtime data
 pids
 *.pid

README.md

@@ -73,6 +73,10 @@ client
   });
 ```
 
+## Reference Documentation
+
+The generated reference documentationcan be found [here](https://googlemaps.github.io/google-maps-services-js/). The TypeScript types are the authoritative documenation for this library and may differ slightly from the descriptions.
+
 ## Developing
 
 In order to run the end-to-end tests, you'll need to supply your API key via an

package.json

@@ -36,6 +36,7 @@
     "dist"
   ],
   "scripts": {
+    "docs": "rm -rf docs/ && typedoc .",
     "prepare": "tsc",
     "test": "jest src",
     "test:e2e": "jest e2e",
@@ -57,10 +58,11 @@
     "jest": "^25.2.2",
     "semantic-release": "^17.0.2",
     "ts-jest": "^25.2.1",
+    "typedoc": "^0.16.11",
     "typescript": "^3.7.4"
   },
   "publishConfig": {
-    "registry":"https://wombat-dressing-room.appspot.com",
+    "registry": "https://wombat-dressing-room.appspot.com",
     "access": "public"
   },
   "release": {

typedoc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  mode: "modules",
+  target: "es6",
+  out: "docs",
+  exclude: ["**/node_modules/**", "**/*.spec.ts", "**/*.test.ts", "dist"],
+  name: "Google Maps Services Node Client",
+  ignoreCompilerErrors: false,
+  module: "commonjs",
+  readme: "./README.md"
+};