Class: Yarrow::Generator
- Inherits:
-
Object
- Object
- Yarrow::Generator
- Defined in:
- lib/yarrow/generator.rb
Overview
Generates documentation from a model.
Subclasses of Generator need to override the template methods, to specify a particular file structure to output.
Instance Method Summary collapse
- #build_docs ⇒ Object
- #ensure_dir_exists!(target) ⇒ Object
-
#initialize(target, site_tree) ⇒ Generator
constructor
A new instance of Generator.
Constructor Details
#initialize(target, site_tree) ⇒ Generator
Returns a new instance of Generator.
9 10 11 12 13 |
# File 'lib/yarrow/generator.rb', line 9 def initialize(target, site_tree) ensure_dir_exists! target @target = target @site_tree = site_tree end |
Instance Method Details
#build_docs ⇒ Object
21 22 23 |
# File 'lib/yarrow/generator.rb', line 21 def build_docs end |
#ensure_dir_exists!(target) ⇒ Object
15 16 17 18 19 |
# File 'lib/yarrow/generator.rb', line 15 def ensure_dir_exists!(target) unless File.directory? target Dir.mkdir target end end |