如何在使用码头创建文档时阻止[查看源代码]链接?

时间:2011-08-19 02:07:10

标签: ruby rake yard

我使用院子来生成项目文档,但我不想在文档中显示[查看源代码]链接,我已经潜入院子官方指南但仍然没有得到解决方案。

有什么想法吗?感谢。

3 个答案:

答案 0 :(得分:6)

我可能会有点迟,但您可以通过从method_details部分删除“source”部分来轻松自定义默认模板。您可以通过在项目的根目录中创建文件“my_template / default / method_details / setup.rb”来实现此目的:

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

然后,您可以使用自定义模板修改来调用YARD:

$ yardoc -p my_template

答案 1 :(得分:0)

我无法在院子里找到直接的方法,但您可以尝试在生成的码文档文件夹中运行以下命令:

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

答案 2 :(得分:0)

目前我只使用javascript删除源html:

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