Module: Lorca::LorcaDoc

Defined in:
lib/lorca/doc.rb

Overview

Aimed at gemspec, and supported doc generators.

Class Method Summary collapse

Class Method Details

.appendices ⇒ Object

Array of extra doc files. These should be listed in Manifest.md.



38
39
40
 
# File 'lib/lorca/doc.rb', line 38

def self.appendices
  Lorca::LorcaManifest.files.select { |f| f.end_with? ".md" }
end

.build_options ⇒ Object

Array of options used for building the documentation.



22
23
24
25
26
27
28
 
# File 'lib/lorca/doc.rb', line 22

def self.build_options
  [
    "--line-numbers",
    "--title", "#{LorcaManifest.official_name}: #{self.summary}",
    "--main", "ReadMe.md"
  ]
end

.description ⇒ Object

Short description of what Lorca does, and how does it do it.



14
15
16
17
18
19
 
# File 'lib/lorca/doc.rb', line 14

def self.description
  <<~EOH
  Lorca is a passphrase generator based on diceware made available by the EFF.
  Passwords, and pins are handle by the system's pseudo-random generator.
  EOH
end

.files ⇒ Object

Array of documented files. These should be listed in Manifest.md.



31
32
33
34
35
 
# File 'lib/lorca/doc.rb', line 31

def self.files
  Lorca::LorcaManifest.files.select { |f|
    Lorca::LorcaManifest.codebase.any? { |dir| f.start_with? dir }
  }
end

.summary ⇒ Object

One line summary of what Lorca is.



9
10
11
 
# File 'lib/lorca/doc.rb', line 9

def self.summary
  "Passphrase, and password generator"
end