623 add ci travis only jsdoc generation doc #624
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
valentinMachado
force-pushed
the
623-add-ci-travis-only-jsdoc-generation-doc
branch
from
edf7825 to
b29a0ae
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rebase on this #612 (<== first merge it to see which files changed)
I add a validate doc generation (in ./bin/valdidateDocs.js) which basically check if the returned log of
npm run docsincludes someWARNINGorERRORoccurence. I didn't make an npm script for that since this cmd is meant to be only used while the travis CI.Since there were some warnings and errors some related to this #552 I fixed these and create a tutorials hierarchy based on ./docs/static/tutorials.json which is the way for describing tutorials hierarchy in jsdoc
close #552