Skip to content

Commit 4020637

Browse files
authored
docs: check broken links in generated docs (#268)
* build: check dead links on Kokoro * recursive crawl local links * add longrunning module * fix link (already fixed in protos
1 parent 5850574 commit 4020637

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

packages/google-cloud-node/.jsdoc.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ module.exports = {
2020
opts: {
2121
readme: './README.md',
2222
package: './package.json',
23-
template: './node_modules/ink-docstrap/template',
23+
template: './node_modules/jsdoc-baseline',
2424
recurse: true,
2525
verbose: true,
2626
destination: './docs/'

packages/google-cloud-node/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"eslint-config-prettier": "^3.0.0",
5656
"eslint-plugin-node": "^8.0.0",
5757
"eslint-plugin-prettier": "^3.0.0",
58-
"ink-docstrap": "^1.3.2",
58+
"jsdoc-baseline": "git+https://github.com/hegemonic/jsdoc-baseline.git",
5959
"intelli-espower-loader": "^1.0.1",
6060
"jsdoc": "^3.5.5",
6161
"mocha": "^5.2.0",

packages/google-cloud-node/src/index.js

+3
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@
3636
/**
3737
* @namespace google.rpc
3838
*/
39+
/**
40+
* @namespace google.longrunning
41+
*/
3942

4043
'use strict';
4144

packages/google-cloud-node/src/v1/doc/google/cloud/speech/v1/doc_cloud_speech.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -689,4 +689,4 @@ const SpeechRecognitionAlternative = {
689689
*/
690690
const WordInfo = {
691691
// This is for documentation. Actual contents will be loaded by gRPC.
692-
};
692+
};

0 commit comments

Comments
 (0)