Module: Origen::Generator::Compiler::DocHelpers::SearchableHelpers

Included in:
Origen::Generator::Compiler::DocHelpers
Defined in:
lib/helpers.rb

Overview

Helpers for the searchable doc layout

Instance Method Summary collapse

Instance Method Details

#_doc_root_dir(options) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/helpers.rb', line 199

def _doc_root_dir(options)
  f = options[:root]
  @_doc_root_dirs ||= {}
  return @_doc_root_dirs[f] if @_doc_root_dirs[f]
  unless File.exist?(f)
    f = Pathname.new("#{Origen.root}/templates/web/#{f}")
    unless f.exist?
      fail "#{options[:root]} does not exist!"
    end
  end
  f = Pathname.new(f) if f.is_a?(String)
  @_doc_root_dirs[options[:root]] = f
end

#_resolve_tab(options) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/helpers.rb', line 213

def _resolve_tab(options)
  tab = tab.to_s.downcase
  active = false
  if options[:tab]
    options[:tab]
  else
    rel = options[:top_level_file].relative_path_from(_doc_root_dir(options)).sub_ext('').sub_ext('').to_s
    rel.gsub(/(\/|\\)/, '_').downcase.to_sym
  end
end

#_root_path(options) ⇒ Object 



224
225
226
227
 
# File 'lib/helpers.rb', line 224

def _root_path(options)
  root = Pathname.new("#{Origen.root}/templates/web")
  _doc_root_dir(options).relative_path_from(root)
end