kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
41 Commits 1 Branch 14 Tags 1.1 MiB
Ruby 92.6%
HTML 7.3%
Go to file
Charlie Sharpsteen 0307f0f5e9 Add new PuppetNamespaceObject class 
This class is functionally equivalent to the ModuleObject class that YARD uses
for Ruby code. Using a new class allows us to gather YARD objects related to
Puppet and separate them from the Ruby bits.
 		2014-06-12 21:12:37 -07:00
lib Add new PuppetNamespaceObject class 2014-06-12 21:12:37 -07:00
spec Initial commit 2014-05-16 10:57:24 -07:00
.gitignore Add Bundler artifacts to .gitignore 2014-05-25 19:11:32 -07:00
.yardopts Exclude YARD templates directory from yard doc 2014-06-10 20:38:01 -07:00
README.md Require Puppet >= 3.6.0 2014-06-09 21:20:56 -07:00
Rakefile Initial commit 2014-05-16 10:57:24 -07:00
metadata.json Require Puppet >= 3.6.0 2014-06-09 21:20:56 -07:00

README.md

Puppet YARDoc

A Puppet Face and plugin built on the YARD Documentation Tool and Puppet Future Parser.

WARNING: This is very much a science experiment in progress. Things may blow up or change rapidly depending on the Temperature in Portland on a given day.

Installation

So far, this module has been developed against Puppet 3.6.x. It will not work with earlier versions.

Currently, just git clone directly into the Puppet modulepath. Ensure the yard and rgen gems are installed. If running Ruby 1.8.7, ensure the backports gem is installed.

Usage

Documenting a module:

cd /path/to/module
puppet yardoc

This processes README and everything in manifests/**/*.pp.

Documenting specific manifests:

puppet yardoc some_manifest.pp [another_if_you_feel_like_it.pp]

Processing is delegated to the yardoc tool so some options listed in yard help doc are available. However, Puppet Faces do not support passing arbitrary options through a face so these options must be specified in a .yardopts file.

Caveats

  • At the moment, only top-level Classes and Defined Types are parsed and formatted.

  • Documentation blocks must immediately precede the documented code with no whitespace. This is because the comment extractor possesses the elegance and intelligance of a bag of hammers.

  • Support for Ruby 1.8.7 may disappear in the future.

  • This is a science experiment. It has a high probability of exploding catastrophically instead of doing something useful.