Skip to content

Commit c9cc9c5

Browse files
committed
Work-around for #477
Compile the TS to JS to include those files in the compiled documentation. This is not ideal, since the types are omitted from such documentation
1 parent e9c9868 commit c9cc9c5

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

docs/Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,12 @@ clean:
4343
# Generate output commands
4444
.PHONY: jsdoc
4545
jsdoc:
46-
cd .. && npm run js-doc
46+
# Compile the TypeScript sources to JS first. Several modules (e.g. the
47+
# UUID types) live only as .ts files whose compiled .js output is
48+
# git-ignored; without this step JSDoc never sees them and their docs are
49+
# missing from the build.
50+
# TODO: This is only temporary work-around for #477
51+
cd .. && npm run build && npm run js-doc
4752
@echo
4853
@echo "JSDoc build finished. The API docs are in ../public/docs/."
4954

0 commit comments

Comments
 (0)