43e429fa93
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)
34 lines
756 B
Makefile
34 lines
756 B
Makefile
BASEDIR = $(CURDIR)
|
|
CLASSES = $(BASEDIR)/classes/ $(BASEDIR)/../modules/
|
|
OUTPUTDIR = $(BASEDIR)/_build
|
|
TOOLSDIR = $(BASEDIR)/tools
|
|
JSDIR = $(BASEDIR)/../platform/javascript
|
|
|
|
.ONESHELL:
|
|
|
|
clean:
|
|
rm -rf $(OUTPUTDIR)
|
|
|
|
doxygen:
|
|
rm -rf $(OUTPUTDIR)/doxygen
|
|
mkdir -p $(OUTPUTDIR)/doxygen
|
|
doxygen Doxyfile
|
|
|
|
markdown:
|
|
rm -rf $(OUTPUTDIR)/markdown
|
|
mkdir -p $(OUTPUTDIR)/markdown
|
|
pushd $(OUTPUTDIR)/markdown
|
|
python2 $(TOOLSDIR)/makemd.py $(CLASSES)
|
|
popd
|
|
|
|
rst:
|
|
rm -rf $(OUTPUTDIR)/rst
|
|
mkdir -p $(OUTPUTDIR)/rst
|
|
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
|