yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/v8/feature/improve-js-docs' into v8/feature/block-editor-list

Browse Source
This commit is contained in:
Niels Lyngsø
2020-06-17 15:33:29 +02:00
parent e0ae0c084b 25488d2016
commit a132e12ff9
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Umbraco.Web.UI.Docs/gulpfile.js
View File

@@ -8,6 +8,8 @@ var connect = require('gulp-connect');
var open = require('gulp-open');
var gulpDocs = require('gulp-ngdocs');
var documentationFiles = ['../Umbraco.Web.UI.Client/src/common/**/*.js', './src/api/**/*.ngdoc'];
/**************************
* Build Backoffice UI API documentation
**************************/
@@ -24,14 +26,14 @@ gulp.task('docs', [], function (cb) {
return gulpDocs.sections({
api: {
glob: ['../Umbraco.Web.UI.Client/src/common/**/*.js', './src/api/**/*.ngdoc'],
glob: documentationFiles,
api: true,
title: 'UI API Documentation'
}
})
.pipe(gulpDocs.process(options))
.pipe(gulp.dest('./api'));
cb();
});
gulp.task('connect:docs', function (cb) {
@@ -44,6 +46,10 @@ gulp.task('connect:docs', function (cb) {
cb();
});
gulp.task('watch:docs', function (cb) {
return gulp.watch(documentationFiles, ['docs']);
});
gulp.task('open:docs', function (cb) {
var options = {
@@ -55,5 +61,5 @@ gulp.task('open:docs', function (cb) {
cb();
});
gulp.task('watch', ['docs', 'connect:docs', 'open:docs']);
gulp.task('watch', ['docs', 'connect:docs', 'open:docs', 'watch:docs']);