Module: Puppet::Util::RDoc

Defined in:
lib/puppet/util/rdoc.rb

Class Method Summary collapse

Class Method Details

.manifestdoc(files) ⇒ Object

launch an output to console manifest doc


43
44
45
# File 'lib/puppet/util/rdoc.rb', line 43

def manifestdoc(files)
  raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
end

.output(file, ast) ⇒ Object

Outputs to the console the documentation of a manifest


49
50
51
# File 'lib/puppet/util/rdoc.rb', line 49

def output(file, ast)
  raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
end

.output_astnode_doc(ast) ⇒ Object


53
54
55
# File 'lib/puppet/util/rdoc.rb', line 53

def output_astnode_doc(ast)
  raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
end

.output_resource_doc(code) ⇒ Object


57
58
59
# File 'lib/puppet/util/rdoc.rb', line 57

def output_resource_doc(code)
  raise _("RDOC SUPPORT FOR MANIFEST HAS BEEN REMOVED - See PUP-3638")
end

.rdoc(outputdir, files, charset = nil) ⇒ Object

launch a rdoc documentation process with the files/dir passed in files


7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'lib/puppet/util/rdoc.rb', line 7

def rdoc(outputdir, files, charset = nil)

  # then rdoc
  require 'rdoc/rdoc'
  require 'rdoc/options'

  # load our parser
  require 'puppet/util/rdoc/parser'

  r = RDoc::RDoc.new

  # specify our own format & where to output
  options = [ "--fmt", "puppet",
              "--quiet",
              "--exclude", "/modules/[^/]*/spec/.*$",
              "--exclude", "/modules/[^/]*/files/.*$",
              "--exclude", "/modules/[^/]*/tests/.*$",
              "--exclude", "/modules/[^/]*/templates/.*$",
              "--op", outputdir ]

  options << "--force-update"
  options += [ "--charset", charset] if charset
  # Rdoc root default is Dir.pwd, but the win32-dir gem monkey patches Dir.pwd
  # replacing Ruby's normal / with \.  When RDoc generates relative paths it
  # uses relative_path_from that will generate errors when the slashes don't
  # properly match.  This is a workaround for that issue.
  if Puppet::Util::Platform.windows? && RDoc::VERSION !~ /^[0-3]\./
    options += [ "--root", Dir.pwd.tr('\\', '/')]
  end
  options += files

  # launch the documentation process
  r.document(options)
end