kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
puppet-strings/lib/puppetx/yardoc/yard/templates/default/layout/html/setup.rb

10 lines
387 B
Ruby
Raw Normal View History

Move Puppet classes into a custom namespace Instead of documenting Puppet classes using `ClassObject`, use a custom subclass of `NamespaceObject`. This is done because Puppet classes are not Ruby classes and will have components that don't fit into the model offered by `ClassObject`. This commit also adds a couple of monkey patches to integrate the new `:hostclass` into YARD tooling and the beginnings of some custom templating.
2014-05-26 05:59:46 +00:00
# TODO: This should be extendable. However, the re-assignment of
# @objects_by_letter prevents that. Submit a pull request.
def index
@objects_by_letter = {}
Extend doc generation to defined types Puppet Yardoc now generates documentation for defined types in addition to host classes. The actual change was fairly small, however this patch is quite large as most of the host class bits were re-architected to inherit from defined types. Host classes are basically the same as defined types with the addition of inheritance. Pops also models Host Class using a similar inheritance relationship.
2014-05-30 16:28:25 +00:00
objects = Registry.all(:class, :module, :hostclass, :definedtype).sort_by {|o| o.name.to_s }
Move Puppet classes into a custom namespace Instead of documenting Puppet classes using `ClassObject`, use a custom subclass of `NamespaceObject`. This is done because Puppet classes are not Ruby classes and will have components that don't fit into the model offered by `ClassObject`. This commit also adds a couple of monkey patches to integrate the new `:hostclass` into YARD tooling and the beginnings of some custom templating.
2014-05-26 05:59:46 +00:00
objects = run_verifier(objects)
objects.each {|o| (@objects_by_letter[o.name.to_s[0,1].upcase] ||= []) << o }
erb(:index)
end