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.
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:
<
and>
are not escaped which means various examples aren't very usable.