Class: Jazzy::DocBuilder::DocsetBuilder
- Inherits:
-
Object
- Object
- Jazzy::DocBuilder::DocsetBuilder
- Includes:
- Config::Mixin
- Defined in:
- lib/jazzy/docset_builder.rb
Overview
Follows the instructions found at kapeli.com/docsets#dashDocset.
Instance Attribute Summary collapse
-
#docset_dir ⇒ Object
readonly
Returns the value of attribute docset_dir.
-
#documents_dir ⇒ Object
readonly
Returns the value of attribute documents_dir.
-
#generated_docs_dir ⇒ Object
readonly
Returns the value of attribute generated_docs_dir.
-
#output_dir ⇒ Object
readonly
Returns the value of attribute output_dir.
-
#source_module ⇒ Object
readonly
Returns the value of attribute source_module.
Instance Method Summary collapse
- #build! ⇒ Object
-
#initialize(generated_docs_dir, source_module) ⇒ DocsetBuilder
constructor
A new instance of DocsetBuilder.
Methods included from Config::Mixin
Constructor Details
#initialize(generated_docs_dir, source_module) ⇒ DocsetBuilder
Returns a new instance of DocsetBuilder.
16 17 18 19 20 21 22 23 24 |
# File 'lib/jazzy/docset_builder.rb', line 16 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.
13 14 15 |
# File 'lib/jazzy/docset_builder.rb', line 13 def docset_dir @docset_dir end |
#documents_dir ⇒ Object (readonly)
Returns the value of attribute documents_dir.
14 15 16 |
# File 'lib/jazzy/docset_builder.rb', line 14 def documents_dir @documents_dir end |
#generated_docs_dir ⇒ Object (readonly)
Returns the value of attribute generated_docs_dir.
11 12 13 |
# File 'lib/jazzy/docset_builder.rb', line 11 def generated_docs_dir @generated_docs_dir end |
#output_dir ⇒ Object (readonly)
Returns the value of attribute output_dir.
10 11 12 |
# File 'lib/jazzy/docset_builder.rb', line 10 def output_dir @output_dir end |
#source_module ⇒ Object (readonly)
Returns the value of attribute source_module.
12 13 14 |
# File 'lib/jazzy/docset_builder.rb', line 12 def source_module @source_module end |
Instance Method Details
#build! ⇒ Object
26 27 28 29 30 31 32 33 34 |
# File 'lib/jazzy/docset_builder.rb', line 26 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 |