Module: GemDocs::Yard

Defined in:
lib/gem_docs/yard.rb

Class Method Summary collapse

Class Method Details

.generate(supress_out: false) ⇒ Object

Generate HTML documentation via YARD



6
7
8
9
10
11
12
13
14
 
# File 'lib/gem_docs/yard.rb', line 6

def self.generate(supress_out: false)
  write_yardopts
  Dir.chdir(GemDocs.project_root) do
    redirect = supress_out ? '>/dev/null 2>&1' : ''
    unless system("yard doc --no-private #{redirect}")
      abort "Failed to generate YARD documentation"
    end
  end
end