Как предотвратить ссылку [view source] при создании документации с использованием ярда?

Question

Я использую ярд для генерации проектной документации, но я не хочу отображать ссылку [просмотреть исходный код] в документации, я погрузился в официальные руководства ярда, но все еще не понимаю решения.

Есть идеи?Спасибо.

Answer 1

Возможно, я немного опоздал, но вы можете тривиально настроить шаблон по умолчанию, удалив раздел «source» из части method_details. Вы можете сделать это, создав файл "my_template / default / method_details / setup.rb" в корневом каталоге вашего проекта с содержанием:

def init
  super
  sections.first.delete(:source)
end

Затем вы можете позвонить в YARD с вашими модифицированными шаблонами:

$ yardoc -p my_template

Answer 2

В настоящее время я просто использую JavaScript для удаления исходного HTML:

$('.showSource').remove();

Answer 3

Я не смог найти прямой способ сделать это во дворе, но вы можете попробовать запустить следующее в сгенерированной папке документации двора:

require "find"

Find.find(".") do |file|
  if file.match(/\.html$/)
    puts "Filtering #{file}"
    content = File.read(file)
    no_source_content = content.gsub(/<table class="source_code".*?<\/table>/m, "")
    File.open(file, "w") { |io| io.write no_source_content }
  end
end

unless File.read("css/common.css").match(/Hide source links/)
  File.open("css/common.css", "a+") { |io| io.write("\n/* Hide source links */\n.toggleSource { display:none }") }
end

https://gist.github.com/1306615