Class: Prmd::RakeTasks::Doc

Inherits:
Base
  • Object
show all
Defined in:
lib/prmd/rake_tasks/doc.rb

Overview

Documentation rake task

Examples:

Prmd::RakeTasks::Doc.new do |t|
  t.files = { 'schema/api.json' => 'schema/api.md' }
end

Instance Attribute Summary collapse

Attributes inherited from Base

#name, #options

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Doc #initialize(options) ⇒ Doc

Creates a new task with name name.

Overloads:

  • #initialize(name) ⇒ Doc

    Parameters:

    • (String)
  • #initialize(options) ⇒ Doc

    Parameters:

    • options (Hash<Symbol, Object>) —

      .option [Array<String>, Hash<String, String>] files schema files



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/prmd/rake_tasks/doc.rb', line 34

def initialize(*args, &block)
  options = legacy_parameters(*args)
  @files = options.fetch(:files) { [] }
  super options, &block
  if @options[:settings].is_a? String
    settings = Prmd.load_schema_file(@options[:settings])
    @options.merge! HashHelpers.deep_symbolize_keys(settings)
  end
  @options[:template] ||= Prmd::Template.template_dirname
end

Instance Attribute Details

#files ⇒ Array<String>, Hash<String, String>

Schema files that should be rendered

Returns:

  • (Array<String>, Hash<String, String>) —

    list of files



23
24
25
 
# File 'lib/prmd/rake_tasks/doc.rb', line 23

def files
  @files
end

#toc ⇒ Object

Returns the value of attribute toc.



25
26
27
 
# File 'lib/prmd/rake_tasks/doc.rb', line 25

def toc
  @toc
end