Generating Yard documentation for existing LWRP's

[dasbiswajit]

Hi Team, Thanks for fantastic library. My requirement is - I want to show cookbook's LWRP documentation. Is there any way to show this. Here is the code from my recipe-

#Install 'splunkforwarder' package
package 'splunkforwarder' do
  version node['sap-splunk-client']['version']
  action :install
  not_if { File.exist?("#{node['sap-splunk-client']['splunk_home']}/splunk-#{node['sap-splunk-client']['version']}-x86_64-manifest") }
end

I am expecting something to show under resource-

Can you please help me??

[nitinmohan87]

@dasbiswajit Thanks a lot for your feedback. It has been a while since we looked into this plugin. So, I apologize if I am not making much sense.

Are you asking if this gem adds documentation for existing Chef LWRPs like https://docs.chef.io/resource_package.html (for example)? I don't think it adds documentation for existing LWRPs because the Chef website already has detailed docs for them. The primary use case for this library is to view docs for custom LWRPs that you add to your cookbooks. May I know why would you like to see docs for existing LWRPs in the yard docs?

[damm]

I personally use yard-chef for my documentation at github.com/damm/backup (I find it really snazzy and I love the presentation)

For me the resource list; lists my LWRP's. What you have listed in your original post was a package resource; it would not be listed there. See my screenshot.

[dasbiswajit]

Thank you @nitinmohan87 and @damm for your detail explanation and description. For me as well yard-chef is showing for custom LWRP's. Just wondering if there any way to achieve existing chef resources which is used in recipies. By custom tags, metadata.rb or some other way which will filter the existing LWRP's Like package ,ruby_block, templates...etc.

At least if it shows list of LWRP's used in a cookbook. It will be really help full for me.