theforeman / puppet-pulp

Puppet module for setting up Pulp 2 as part of Katello installation
GNU General Public License v3.0
16 stars 66 forks source link

Convert documentation to yardoc #367

Closed ekohl closed 5 years ago

ekohl commented 5 years ago

This converts the documentation from RDoc to Yardoc. The benefit is that puppet-strings can read it which allows easy generation of reference documentation (rake strings:generate:reference). The only benefit of RDoc over Yardoc is support for groups which the installer can use to hide advanced sections, but this module isn't exposed by the installer and didn't have any groups.

For the 6.0.0 release I did this locally which results in https://forge.puppet.com/katello/pulp/reference. There are still some issues:

alexjfisher commented 5 years ago

Any reason behind not using @summary tag?

ekohl commented 5 years ago

Lazyness? This just converted the parameters and got a mostly usable reference. As I said: there are still issues :)