how do i run for all my files?

[nrser]

hey, i'm just getting started with documentation.js (and gulp). the README gives examples of generating docs for a single file, but i'd like to generate docs for all my files.

i'm trying

gulp.task('doc', () => {
  gulp.src('./meteor/imports/**/*.js')
    .pipe(debug())
    .pipe(documentation({shallow: true, format: 'md'}))
    .pipe(gulp.dest('./doc'));
});

and i can see all the files going through from the debug output but the result seems to be a single API.md for a single file.

i'm using Meteor which has weird imports so the dependency following thing doesn't work (hence this shallow: true part).

thanks.

[tmcw]

Sure, I'm updating this module to documentation v4 and updating the readme with a multi-file example.

[rwam]

It seems your documentation should be updated. When I use

gulp.task('documentation', function() {
    gulp.src('app/js/**/*.js')
        .pipe(gulpDocumentation({
            format: 'html'
        }))
        .pipe(gulp.dest('docs/api'));
});

I get the following error:

[10:59:38] Error: invalid format given: valid options are html, md, remark, json
    at module.exports (/…/…/Workspace/pm-wg-angular/node_modules/gulp-documentation/index.js:82:11)
    …

[rwam]

And it works only, when the task returns the stream. Otherwise no output is generated ;(

[tmcw]

Hi @rwam - the recent version bump to 3.0.0 included a breaking change, along with updated examples. To update to 3.0.0, your code would look like:

gulp.task('documentation', function() {
    gulp.src('app/js/**/*.js')
        .pipe(gulpDocumentation('html'))
        .pipe(gulp.dest('docs/api'));
});

That that modified version out and let me know if it still doesn't work with the change.

[rwam]

Hi @tmcw – I use version 3.0.0 and yes I tried it as described. But it only write it on the output directory when I use a return statement:

gulp.task('documentation', function() {
    return gulp.src('app/js/**/*.js')
        .pipe(gulpDocumentation('html'))
        .pipe(gulp.dest('docs/api'));
});

Ok I see the info on the 3.0.0 tag is actual, but it's a little weird ;) There is a missing character:

[tmcw]

Thanks for spotting that! I've updated the code examples so they should be functional.