Add gulp docs task to generate documentation

This commit is contained in:
Matt Mazzola 2016-07-13 09:02:27 -07:00
Родитель 4bab40f243
Коммит 0ab57d2f18
3 изменённых файлов: 26 добавлений и 1 удалений

4
.gitignore поставляемый
Просмотреть файл

@ -2,4 +2,6 @@ node_modules
coverage
typings
dist
tmp
docs
docs.json
tmp

Просмотреть файл

@ -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,26 @@ gulp.task('test', 'Run 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.3",
"jasmine-core": "^2.4.1",
"jquery": "^2.2.3",
@ -48,6 +49,7 @@
"phantomjs-prebuilt": "^2.1.7",
"run-sequence": "^1.1.5",
"ts-loader": "^0.8.2",
"typedoc": "^0.4.4",
"webpack-stream": "^3.2.0",
"yargs": "^4.6.0"
},