Module: Docco

Defined in:
lib/docco.rb,
lib/docco/theme.rb,
lib/docco/parser.rb,
lib/docco/writer.rb,
lib/docco/builder.rb,
lib/docco/version.rb,
lib/docco/parser/root.rb,
lib/docco/parser/section.rb,
lib/docco/themes/default.rb,
lib/docco/parser/content_node.rb

Defined Under Namespace

Modules: Themes Classes: Builder, DocsBuilder, Info, Parser, Theme, Writer

Constant Summary collapse

STYLES = 
'styles.css'
GHACTION = 
'deploy-docs.yml'
GHACTION_DIR = 
File.join('.github', 'workflows')
CopyGHAction = 
proc do
  FileUtils.mkdir_p(GHACTION_DIR)
  source = File.join(__dir__, 'docco', GHACTION)
  destination = File.join(GHACTION_DIR, GHACTION)
  FileUtils.cp(source, destination)
  puts "Github action copied to #{destination}"
end
VERSION = 
"0.1.2"

Class Method Summary collapse

Class Method Details

.parse(text) ⇒ Object 



23
24
25
26
 
# File 'lib/docco.rb', line 23

def self.parse(text)
  parser = Parser.new(text)
  parser.structure
end

.write(pages, output_dir:, overwrite: false) ⇒ Object 



28
29
30
31
 
# File 'lib/docco.rb', line 28

def self.write(pages, output_dir:, overwrite: false)
  writer = Writer.new(pages, output_dir:, overwrite:)
  writer.write
end