Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build: check broken links in generated docs #511

Merged
merged 7 commits into from Jan 15, 2019
Merged

build: check broken links in generated docs #511

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b79d493
build: check dead links on Kokoro
jkwlui Dec 28, 2018
cf67ff3
recursive crawl local links
jkwlui Dec 29, 2018
1f03cb8
Merge branch 'master' into jsdoc-link-checker
jkwlui Jan 15, 2019
175673c
add @private jsdoc tag to methods of private classes
jkwlui Jan 15, 2019
17d1041
fix dead links in timestamp
jkwlui Jan 15, 2019
c3be6c2
npm run fix
jkwlui Jan 15, 2019
f12100f
stop running lint post test
jkwlui Jan 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .jsdoc.js
View file
Open in desktop
Expand Up @@ -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/'
Expand Down
8 changes: 8 additions & 0 deletions .kokoro/docs.sh
View file
Open in desktop
Expand Up @@ -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
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Expand Up @@ -74,7 +74,7 @@
"duplexify": "^3.6.0",
"gts": "^0.9.0",
"hard-rejection": "^1.0.0",
"ink-docstrap": "git+https://github.com/docstrap/docstrap.git",
"jsdoc-baseline": "git+https://github.com/hegemonic/jsdoc-baseline.git",
"intelli-espower-loader": "^1.0.1",
"jsdoc": "^3.5.5",
"mocha": "^5.2.0",
Expand Down