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.

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

623 add ci travis only jsdoc generation doc #624

Merged
merged 11 commits into from
Apr 27, 2023

Conversation

valentinMachado
Copy link
Contributor

@valentinMachado valentinMachado commented Apr 21, 2023

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 docs includes some WARNING or ERROR occurence. 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

@valentinMachado valentinMachado linked an issue Apr 21, 2023 that may be closed by this pull request
@valentinMachado valentinMachado self-assigned this Apr 21, 2023
@valentinMachado valentinMachado force-pushed the 623-add-ci-travis-only-jsdoc-generation-doc branch from edf7825 to b29a0ae Compare April 24, 2023 15:05
Copy link
Contributor

@mathieuLivebardon mathieuLivebardon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌚

@mathieuLivebardon mathieuLivebardon merged commit 99ff52f into master Apr 27, 2023
3 checks passed
@valentinMachado valentinMachado deleted the 623-add-ci-travis-only-jsdoc-generation-doc branch April 27, 2023 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CI travis only jsdoc generation doc Tutorials do not consider directory hierarchy
2 participants