Class: Doc::RootMerger

Inherits:
Merger show all
Defined in:
lib/doc/root_merger.rb

Instance Attribute Summary

Attributes inherited from Merger

#tasks

Attributes inherited from BaseTask

#config, #dir_name, #documentor, #title

Instance Method Summary collapse

Methods inherited from Merger

#build, #initialize, #symlink_children_to, #symlink_to

Methods inherited from BaseTask

#control_files_exist?, #eql?, #failed?, #hash, #initialize, #loaded_gem_version, #run?, state_methods, #succeeded?, #symlink_to

Constructor Details

This class inherits a constructor from Doc::Merger

Instance Method Details

#doc_dir ⇒ Object 



3
4
5
 
# File 'lib/doc/root_merger.rb', line 3

def doc_dir
  documentor.public_dir
end

#progress_message ⇒ Object 



11
12
13
 
# File 'lib/doc/root_merger.rb', line 11

def progress_message
  'building docs'
end

#public_doc_dir ⇒ Object 



7
8
9
 
# File 'lib/doc/root_merger.rb', line 7

def public_doc_dir
  doc_dir / documentor.docs_dir.basename
end

#run ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/doc/root_merger.rb', line 15

def run
  super
  if succeeded?
    public_doc_dir.mkpath
    symlink_children_to(public_doc_dir)
  end
end

#task_url(task) ⇒ Object 



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

def task_url(task)
  documentor.docs_dir.basename / task.doc_dir.basename
end