[HTML5] Add jsdoc2rst tool.
A template for `jsdoc` that generat the HTML5 public classref.
The script can be run via `npm run docs` to print to stdout.
You can dry run via `npm run docs -- --d dry-run` or write to file via
`npm run docs -- -d /path/to/file.rst`
Also update Makefile in `doc/` and add dry run test to CI.
(cherry picked from commit 472482013e)
This commit is contained in:
committed by
Rémi Verschelde
parent
681c10af45
commit
43e429fa93
3
.github/workflows/static_checks.yml
vendored
3
.github/workflows/static_checks.yml
vendored
@ -35,11 +35,12 @@ jobs:
|
||||
run: |
|
||||
bash ./misc/scripts/black_format.sh
|
||||
|
||||
- name: JavaScript style checks via ESLint
|
||||
- name: JavaScript style and documentation checks via ESLint and JSDoc
|
||||
run: |
|
||||
cd platform/javascript
|
||||
npm ci
|
||||
npm run lint
|
||||
npm run docs -- -d dry-run
|
||||
|
||||
- name: Documentation checks
|
||||
run: |
|
||||
|
||||
Reference in New Issue
Block a user