Issue #20518 has been updated by Jason Antman.
Another big plus for me at least would be something that also generates (or "knows about") README.md for each module, and ties them into the module docs (i.e. rdoc). It might be useful to others, I currently include a 1-line summary in the README.md of every module in my modulepath, and then have a script that pulls together an index file listing every module and its one-line summary, and linking to the docs for the module itself. While I'm at it, I really wish that puppet doc had a way to see into conditionals and document them as such... ---------------------------------------- Feature #20518: Bring in rich module documentation feature https://projects.puppetlabs.com/issues/20518#change-96247 * Author: Yuri Arabadji * Status: Investigating * Priority: Normal * Assignee: * Category: * Target version: * Affected Puppet version: * Keywords: * Branch: ---------------------------------------- `puppet doc --mode rdoc` just isn't enough. It doesn't work on recent ruby (1.9), it generates text documentation that isn't searchable/browseable/useful. What I'd like to see is something akin to <a href="http://docs.puppetlabs.com/references/latest/type.html";>Type Reference</a> on Puppet website, but with TOC and menu on the left that would allow me to search and select what documentation section/type I'd like to browse. For ex., I'd like to see all functions that my module defines, their names, description, number of arguments, type. Same with custom types. The doc output format could be html, but any structural would work, too. Maybe xml with good xslt transform sheet? Or just JSON that can be easily converted to html? Would be nice to have, you know... -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/groups/opt_out.
