Method: Jazzy::DocBuilder.gh_token_url

Defined in:
lib/jazzy/doc_builder.rb

.gh_token_url(item, source_module) ⇒ Object

Construct Github token URL

Parameters:

  • item (Hash) —

    Parsed doc child item

  • options (Config) —

    Build options



204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/jazzy/doc_builder.rb', line 204

def self.gh_token_url(item, source_module)
  if source_module.github_file_prefix && should_link_to_github(item.file)
    relative_file_path = item.file.gsub(`pwd`.strip, '')
    if item.start_line && (item.start_line != item.end_line)
      gh_line = "#L#{item.start_line}-L#{item.end_line}"
    else
      gh_line = "#L#{item.line}"
    end
    source_module.github_file_prefix + relative_file_path + gh_line
  end
end