search

jsBoot / gulp-yuidoc

yuidoc plugin for gulp
MIT License
14 stars 16 forks source link

Generator doesn't honour the nocode option. #12

Open notthetup opened 9 years ago

notthetup commented 9 years ago

YUIDoc options have a (undocumented?) option nocode . That is set internally when the --no-code flag is used on the CLI.

When the option is set, the html version of the code files is NOT copied into the output directory. This is useful if you only want to publish the documentation and not the code.

The gulp-yuidoc copies generator copies the files property of the Parser data regardless of the nocode flag being set.

By adding a simple check we can ensure that the files are only generated if nocode is false. Something like..

https://github.com/notthetup/gulp-yuidoc/commit/55515646443c4a0d318a18b9ca665488b4160f02

vbardales commented 8 years ago

It seems to work for me. Here is my gulp conf:

.pipe(yuidoc(null, {
  nocode: true,
}))

And no code is generated for me. First parameter is parser configuration, second parameter is generator configuration, which takes nocode. But indeed, yuidoc is so lame on documentation....

notthetup commented 8 years ago

Possible. I haven't touched this in a year and a half. So if it has been fixed, feel free to close the issue.