yard server generate Documentation from github repo

460 Views Asked by At

Is there any way to generate Yard documentation from github projects. We have several cookbook with Yard tags ready for parsing with Yard and generating documentation.

Any Ideas?

Thanks Biswajit

2

There are 2 best solutions below

0
On BEST ANSWER

Thanks Noah, I found a solution for this. The best example is -http://www.rubydoc.info/. And the github project like is - http://github.com/lsegal/rubydoc.info. This solves my purpose.

Regards Biswajit

0
On

You can run your own instance of yard server using the yard-chef plugin. You would need to make something to sync the code to the docs server and regenerate the YARD data on changes.