diff options
| author | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2021-02-22 06:10:16 +0100 |
|---|---|---|
| committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2021-02-26 11:33:59 +0100 |
| commit | 472482013e760b0c0334d99b7bf21d9bd2a3a206 (patch) | |
| tree | b5b28f54e507cad8dadb9ff063753c26e3f25779 /doc/Makefile | |
| parent | 018ee5a4dc5c4e885c6dde759df2b9a3c051c30c (diff) | |
[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.
Diffstat (limited to 'doc/Makefile')
| -rw-r--r-- | doc/Makefile | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/Makefile b/doc/Makefile index 9534da9bd5..d4bc53bcf9 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,6 +2,7 @@ BASEDIR = $(CURDIR) CLASSES = $(BASEDIR)/classes/ $(BASEDIR)/../modules/ OUTPUTDIR = $(BASEDIR)/_build TOOLSDIR = $(BASEDIR)/tools +JSDIR = $(BASEDIR)/../platform/javascript .ONESHELL: @@ -16,6 +17,10 @@ doxygen: rst: rm -rf $(OUTPUTDIR)/rst mkdir -p $(OUTPUTDIR)/rst - pushd $(OUTPUTDIR)/rst - python3 $(TOOLSDIR)/makerst.py $(CLASSES) - popd + python3 $(TOOLSDIR)/makerst.py -o $(OUTPUTDIR)/rst $(CLASSES) + +rstjs: + rm -rf $(OUTPUTDIR)/rstjs + mkdir -p $(OUTPUTDIR)/rstjs + npm --prefix $(JSDIR) ci + npm --prefix $(JSDIR) run docs -- --destination $(OUTPUTDIR)/rstjs/html5_shell_classref.rst |