search

rightscale-cookbooks / yard-chef

MIT License
49 stars 16 forks source link

Mode to treat cookbook as root object #9

Closed jhulten closed 7 years ago

jhulten commented 11 years ago

Currently the plugin treats a repository as the root level object. For those of us that publish public cookbooks or have a workflow heavily informed by Berkshelf it would be nice to be able to treat our cookbook as the root of the documentation.

We don't generate documentation for an entire Gemfile, just for the gem we are developing. I think we should at least support the option for the same behavior.

douglaswth commented 11 years ago

We will be looking into making yard-chef fit in better with the Berkshelf Way. Anyway, I was able to get documentation for a cookbook that is in its own directory just fine with . as an argument to the yardoc command:

cd ephemeral_lvm
yardoc --plugin yard-chef .
nitinmohan87 commented 10 years ago

@jhulten Are you still having this issue? The steps shown in @douglaswth's comment should work for your case.

rshade commented 7 years ago

Looks to be solved, closing, if still a problem please re-open