Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generator doesn't honour the nocode option. #12

Open
notthetup opened this issue Jul 30, 2014 · 2 comments
Open

Generator doesn't honour the nocode option. #12

notthetup opened this issue Jul 30, 2014 · 2 comments

Comments

@notthetup
Copy link

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..

notthetup@5551564

@vbardales
Copy link

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants