class Raddocs::App

Sinatra app that serves all documentation

Attributes

markdown[RW]

Public Instance Methods

api_name() click to toggle source
# File lib/raddocs/app.rb, line 87
def api_name
  Raddocs.configuration.api_name
end
css_files() click to toggle source

Loads all necessary css files

@see Raddocs::Configuration for loading external files

# File lib/raddocs/app.rb, line 94
def css_files
  files = ["#{url_location}/codemirror.css", "#{url_location}/application.css"]

  if Raddocs.configuration.include_bootstrap
    files << "#{url_location}/bootstrap.min.css"
  end

  Dir.glob(File.join(docs_dir, "styles", "*.css")).each do |css_file|
    basename = Pathname.new(css_file).basename
    files << "#{url_location}/custom-css/#{basename}"
  end

  files.concat Array(Raddocs.configuration.external_css)

  files
end
docs_dir() click to toggle source
# File lib/raddocs/app.rb, line 111
def docs_dir
  Raddocs.configuration.docs_dir
end
guides() click to toggle source
# File lib/raddocs/app.rb, line 115
def guides
  return [] unless File.exist?(guides_index)
  YAML.load(File.read(guides_index)).map do |guide_hash|
    Guide.new(guide_hash)
  end
end
guides_dir() click to toggle source
# File lib/raddocs/app.rb, line 126
def guides_dir
  Raddocs.configuration.guides_dir
end
guides_index() click to toggle source
# File lib/raddocs/app.rb, line 122
def guides_index
  File.join guides_dir, "guides.yml"
end
url_location() click to toggle source
# File lib/raddocs/app.rb, line 77
def url_location
  "#{url_prefix}#{request.env["SCRIPT_NAME"]}"
end
url_prefix() click to toggle source
# File lib/raddocs/app.rb, line 81
def url_prefix
  url = Raddocs.configuration.url_prefix
  return '' if url.to_s.empty?
  url.start_with?('/') ? url : "/#{url}"
end