Add gulp docs task to generate documentation
This commit is contained in:
Родитель
11ee5e7f8b
Коммит
806e4dc48b
|
@ -2,4 +2,6 @@ node_modules
|
|||
coverage
|
||||
typings
|
||||
dist
|
||||
docs
|
||||
docs.json
|
||||
tmp
|
20
gulpfile.js
20
gulpfile.js
|
@ -3,6 +3,7 @@ var del = require('del'),
|
|||
header = require('gulp-header'),
|
||||
rename = require('gulp-rename'),
|
||||
replace = require('gulp-replace'),
|
||||
typedoc = require("gulp-typedoc"),
|
||||
uglify = require('gulp-uglify'),
|
||||
karma = require('karma'),
|
||||
webpack = require('webpack'),
|
||||
|
@ -37,6 +38,25 @@ gulp.task('test', 'Runs all tests', function (done) {
|
|||
);
|
||||
});
|
||||
|
||||
gulp.task("docs", function () {
|
||||
return gulp
|
||||
.src(["src/**/*.ts"])
|
||||
.pipe(typedoc({
|
||||
mode: 'modules',
|
||||
includeDeclarations: true,
|
||||
|
||||
// Output options (see typedoc docs)
|
||||
out: "./docs",
|
||||
json: "./docs.json",
|
||||
|
||||
// TypeDoc options (see typedoc docs)
|
||||
ignoreCompilerErrors: true,
|
||||
version: true,
|
||||
tsConfig: './tsconfig.json'
|
||||
}))
|
||||
;
|
||||
});
|
||||
|
||||
gulp.task('compile:ts', 'Compile source files', function() {
|
||||
webpackConfig.plugins = [
|
||||
new webpack.BannerPlugin(webpackBanner)
|
||||
|
|
|
@ -35,6 +35,7 @@
|
|||
"gulp-help": "^1.6.1",
|
||||
"gulp-rename": "^1.2.2",
|
||||
"gulp-replace": "^0.5.4",
|
||||
"gulp-typedoc": "^2.0.0",
|
||||
"gulp-uglify": "^1.5.4",
|
||||
"jasmine-core": "^2.4.1",
|
||||
"json-loader": "^0.5.4",
|
||||
|
@ -47,6 +48,7 @@
|
|||
"phantomjs-prebuilt": "^2.1.7",
|
||||
"run-sequence": "^1.2.1",
|
||||
"ts-loader": "^0.8.2",
|
||||
"typedoc": "^0.4.4",
|
||||
"webpack-stream": "^3.2.0",
|
||||
"yargs": "^4.7.1"
|
||||
},
|
||||
|
|
Загрузка…
Ссылка в новой задаче