From e88242c3cc7bb8d696f538fe41b04044cef986f5 Mon Sep 17 00:00:00 2001 From: Benjamin Pannell Date: Thu, 18 May 2017 12:11:04 +0100 Subject: [PATCH] doc: Update doc generation to avoid including extraneous info --- package.json | 4 ++-- tsconfig.doc.json | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 tsconfig.doc.json diff --git a/package.json b/package.json index 4f22d7a..e6b0d33 100644 --- a/package.json +++ b/package.json @@ -34,10 +34,10 @@ "changelog": "node build/changelog.js", "doc": "npm run doc:build && npm run doc:publish && npm run doc:submodule", "predoc:build": "cd ./doc && git checkout gh-pages", - "doc:build": "typedoc --out ./doc --mode file --name Iridium --exclude test/**/* iridium.ts", + "doc:build": "typedoc --out ./doc --mode file --name Iridium --tsconfig tsconfig.doc.json iridium.ts", "postdoc:build": "echo gitdir: ../.git/modules/doc> ./doc/.git", "doc:stage": "cd ./doc && git add -A", - "doc:commit": "cd ./doc && git diff --cached --exit-code && git commit -m \"doc: Update documentation\" || true", + "doc:commit": "cd ./doc && git diff-index --cached --quiet HEAD -- && git commit -m \"doc: Update documentation\" || true", "doc:push": "cd ./doc && git push", "doc:publish": "npm run doc:stage && npm run doc:commit && npm run doc:push", "doc:submodule": "npm run doc:submodule:commit", diff --git a/tsconfig.doc.json b/tsconfig.doc.json new file mode 100644 index 0000000..19bb10d --- /dev/null +++ b/tsconfig.doc.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "version": true, + "module": "commonjs", + "target": "es6", + "sourceMap": true, + "declaration": true, + "experimentalDecorators": true, + "noEmit": true, + "moduleResolution": "node", + "strictNullChecks": true, + "noImplicitThis": true, + "noImplicitAny": true + }, + "exclude": [ + "benchmarks", + "dist", + "example", + "node_modules", + "test" + ] +} \ No newline at end of file