Skip to content

options do not seem to be working #54

@maylortaylor

Description

@maylortaylor

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')) });

Activity

maylortaylor

maylortaylor commented on Jun 1, 2018

@maylortaylor
Author

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"));
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @maylortaylor

        Issue actions

          options do not seem to be working · Issue #54 · documentationjs/gulp-documentation