gulp-documentation icon indicating copy to clipboard operation
gulp-documentation copied to clipboard

options do not seem to be working

Open maylortaylor opened this issue 7 years ago • 1 comments

I have the documentation building correctly via Gulp. However, the options and formatterOptions that i pass in do not seem to affect anything.

My name and version do not get updated. This happens if i use the var objects made above the return call or if i just pass in the object directly into the function like in the return call.

However, The name and version do get updated if i change the name in the package.json file.

Here is my gulp task below: gulp.task('docs', function() { var format = "html"; var options = { name: 'Best Web App', version: '4.5' } var formatterOptions = { name: 'Best Web App', version: '4.5' } return gulp.src(tscConfig.compilerOptions.outDir) .pipe(gulpDocumentation(format, options, { name: "woo", version: "4.5" })) .pipe(gulp.dest('./docs-html')) });

maylortaylor avatar May 29 '18 15:05 maylortaylor

Can confirm that the latest version v3.2.1 breaks the options. (at least the name and version options).

Version 3.2.0 works. The name and version are updated in the built documentation site.

This is my gulp task that worked for 3.2.0 but not for 3.2.1: `gulp.task('docs', function() {

var format = "html"; //[choices: "json", "md", "remark", "html"] [default: "json"]

return gulp.src(tscConfig.compilerOptions.outDir)
    .pipe(gulpDocumentation(format, {}, {
        name: 'Best.Website',
        version: "4.5"
    }))
    .pipe(gulp.dest('./docs'))
    });
     gulp.task("build:docs", gulp.series("clean", "build:tsc", "build", "docs"));

maylortaylor avatar Jun 01 '18 13:06 maylortaylor