diff --git a/.compodocrc b/.compodocrc new file mode 100644 index 0000000..cd8b421 --- /dev/null +++ b/.compodocrc @@ -0,0 +1,10 @@ +--- +tsconfig: ./tsconfig.json +output: ./docs +theme: material +hideGenerator: true +disablePrivate: true +disableProtected: true +disableInternal: true +disableCoverage: true +disableGraph: true diff --git a/.jsdoc.js b/.jsdoc.js index 5ba2069..d7f19d7 100644 --- a/.jsdoc.js +++ b/.jsdoc.js @@ -20,7 +20,7 @@ module.exports = { opts: { readme: './README.md', package: './package.json', - template: './node_modules/ink-docstrap/template', + template: './node_modules/jsdoc-baseline', recurse: true, verbose: true, destination: './docs/' diff --git a/.kokoro/docs.sh b/.kokoro/docs.sh index 3af3193..8ca19ce 100755 --- a/.kokoro/docs.sh +++ b/.kokoro/docs.sh @@ -23,3 +23,11 @@ cd $(dirname $0)/.. npm install npm run docs + +# Check broken links +BIN=./node_modules/.bin + +npm install broken-link-checker +npm install http-server +$BIN/http-server -p 8080 docs/ & +$BIN/blc -r http://localhost:8080 diff --git a/README.md b/README.md index 3795c54..9509668 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ store.delete('key', () => {}); #### datastore -A [@google-cloud/datastore](https://googlecloudplatform.github.io/google-cloud-node/#/docs/datastore/latest/datastore) instance. +A [@google-cloud/datastore](https://cloud.google.com/nodejs/docs/reference/datastore/latest/Datastore) instance. ### kvstore#delete(key, callback) @@ -71,7 +71,7 @@ Type: `String|Number` #### callback Type: `Function` -Executed with the same signature as [Datastore#delete](https://googlecloudplatform.github.io/google-cloud-node/#/docs/datastore/latest/datastore?method=delete). +Executed with the same signature as [Datastore#delete](https://cloud.google.com/nodejs/docs/reference/datastore/latest/Datastore#delete). ### kvstore#get(key, callback) @@ -92,7 +92,7 @@ Type: `*` #### callback Type: `Function` -Executed with the same signature as [Datastore#save](https://googlecloudplatform.github.io/google-cloud-node/#/docs/datastore/latest/datastore?method=save). +Executed with the same signature as [Datastore#save](https://cloud.google.com/nodejs/docs/reference/datastore/latest/Datastore#save). ## Credit diff --git a/package.json b/package.json index 121d9b3..bd16b0b 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "build/src" ], "scripts": { - "docs": "echo no docs 👻", + "docs": "compodoc src/", "lint": "eslint '**/*.js' && gts check", "test": "nyc mocha build/test", "samples-test": "cd samples/ && npm link ../ && npm test && cd ../", @@ -33,6 +33,7 @@ "author": "Stephen Sawchuk", "license": "MIT", "devDependencies": { + "@compodoc/compodoc": "^1.1.7", "@google-cloud/datastore": "^2.0.0", "@types/mocha": "^5.2.5", "@types/node": "^10.5.6", @@ -42,9 +43,7 @@ "eslint-plugin-node": "^8.0.0", "eslint-plugin-prettier": "^3.0.0", "gts": "^0.9.0", - "ink-docstrap": "^1.3.2", "intelli-espower-loader": "^1.0.1", - "jsdoc": "^3.5.5", "mocha": "^5.2.0", "nyc": "^13.0.0", "power-assert": "^1.6.0",