Class: AnsibleDocGenerator::DocGenerator

Inherits:
Object
  • Object
show all
Includes:
PlaybookHelpers
Defined in:
lib/ansible_doc_generator/doc_generator.rb,
lib/ansible_doc_generator/doc_generator/interpolator.rb,
lib/ansible_doc_generator/doc_generator/role_doc_extractor.rb,
lib/ansible_doc_generator/doc_generator/interpolator/file_extractor.rb,
lib/ansible_doc_generator/doc_generator/interpolator/variable_extractor.rb

Defined Under Namespace

Classes: Interpolator, RoleDocExtractor

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(playbook_path, lang) ⇒ DocGenerator

Returns a new instance of DocGenerator.



11
12
13
14
15
 
# File 'lib/ansible_doc_generator/doc_generator.rb', line 11

def initialize playbook_path, lang
  @playbook_path = playbook_path
  @lang = lang
  @md_output = []
end

Instance Attribute Details

#lang ⇒ Object (readonly)

Returns the value of attribute lang.



8
9
10
 
# File 'lib/ansible_doc_generator/doc_generator.rb', line 8

def lang
  @lang
end

#md_output ⇒ Object

Returns the value of attribute md_output.



9
10
11
 
# File 'lib/ansible_doc_generator/doc_generator.rb', line 9

def md_output
  @md_output
end

#playbook_path ⇒ Object (readonly)

Returns the value of attribute playbook_path.



8
9
10
 
# File 'lib/ansible_doc_generator/doc_generator.rb', line 8

def playbook_path
  @playbook_path
end

Instance Method Details

#call ⇒ Object 



17
18
19
20
 
# File 'lib/ansible_doc_generator/doc_generator.rb', line 17

def call
  parse_roles
  write_readme
end