Issue #16426 has been updated by Michael Hall. Due date set to 02/04/2013 Status changed from Accepted to Merged - Pending Release Target version set to 3.1.0
The changes necessary to include YARD documentation as part of the generated references maintained on the docs site are finished and part of the docs toolchain. YARD generation is built into the rake tasks that handle the other generated references (e.g. `VERSION="3.1.0" rake references`). Some changes to the docs site templating are required with each release (e.g. 3.0 -> 3.1), and the generated references for each version require the presence of a corresponding tag in the Puppet repo, so YARD documents for Puppet 3.1 will be published along with navigational links to Puppet 3.1 generated references the same day the Puppet 3.1 tag is cut. ---------------------------------------- Feature #16426: Publish API documentation automatically https://projects.puppetlabs.com/issues/16426#change-82279 Author: Andrew Parker Status: Merged - Pending Release Priority: Immediate Assignee: Michael Hall Category: API Target version: 3.1.0 Affected Puppet version: Keywords: documentation docs yard API backlog Branch: At the moment there is no generated documentation that we automatically publish. This limits our ability to document and publish the public API for using puppet as a library or accessing supported features when writing extensions. There have been some attempts in the past to generate YARD docs and publish them to github as gh-pages, but that effort bit-rotted. We need to come up with a way of creating and maintaining these kinds of docs. -- 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?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
