Class: Jazzy::DocBuilder::DocsetBuilder

Inherits:
Object
  • Object
show all
Includes:
Config::Mixin
Defined in:
lib/jazzy/docset_builder.rb

Overview

Follows the instructions found at kapeli.com/docsets#dashDocset.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Config::Mixin

#config

Constructor Details

#initialize(generated_docs_dir, source_module) ⇒ DocsetBuilder

Returns a new instance of DocsetBuilder.



18
19
20
21
22
23
24
25
26
 
# File 'lib/jazzy/docset_builder.rb', line 18

def initialize(generated_docs_dir, source_module)
  @source_module = source_module
  docset_path = config.docset_path ||
                "docsets/#{source_module.name}.docset"
  @docset_dir = generated_docs_dir + docset_path
  @generated_docs_dir = generated_docs_dir
  @output_dir = docset_dir.parent
  @documents_dir = docset_dir + 'Contents/Resources/Documents/'
end

Instance Attribute Details

#docset_dir ⇒ Object (readonly)

Returns the value of attribute docset_dir.



15
16
17
 
# File 'lib/jazzy/docset_builder.rb', line 15

def docset_dir
  @docset_dir
end

#documents_dir ⇒ Object (readonly)

Returns the value of attribute documents_dir.



16
17
18
 
# File 'lib/jazzy/docset_builder.rb', line 16

def documents_dir
  @documents_dir
end

#generated_docs_dir ⇒ Object (readonly)

Returns the value of attribute generated_docs_dir.



13
14
15
 
# File 'lib/jazzy/docset_builder.rb', line 13

def generated_docs_dir
  @generated_docs_dir
end

#output_dir ⇒ Object (readonly)

Returns the value of attribute output_dir.



12
13
14
 
# File 'lib/jazzy/docset_builder.rb', line 12

def output_dir
  @output_dir
end

#source_module ⇒ Object (readonly)

Returns the value of attribute source_module.



14
15
16
 
# File 'lib/jazzy/docset_builder.rb', line 14

def source_module
  @source_module
end

Instance Method Details

#build! ⇒ Object 



28
29
30
31
32
33
34
35
36
 
# File 'lib/jazzy/docset_builder.rb', line 28

def build!
  docset_dir.rmtree if docset_dir.exist?
  copy_docs
  copy_icon if config.docset_icon
  write_plist
  create_index
  create_archive
  create_xml if config.version && config.root_url
end