0

我想生成一些公开可用的文档，因此我希望删除 Yard 默认生成的输出的某些方面。我已经设法删除了源代码及其链接，但我也想删除：

  • 类名。
  • 继承信息。
  • “定义于”信息。
  • 如果可能的话，“班级名单”| “方法列表” | “文件列表”菜单。

我通过添加删除了源：

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

到路径 .yard_templates/no_source/default/method_details/setup.rb 并在生成时引用它。（感谢这个答案）

尽管维护人员尝试使用有关模板的文档很有帮助，但我只是不知道如何做到这一点。

我尝试查看输出并向后工作，并通过检查sections上面的代码，但我不知道如何确定 HTML 输出中的哪个部分由代码中的什么表示？

任何帮助或见解将不胜感激。

编辑：我找到了如何删除继承信息：

# place in .yard_templates/no_source/default/module/setup.rb
def init
  super
  sections.delete(:box_info)
end
4

1 回答 1

0

删除“类列表” | “方法列表” | “文件列表”菜单：

将以下代码放入 .yard_templates/whatever-you've-call-this-dir/default/layout/html/setup.rb

def menu_lists
  []
end

删除继承信息：

将以下代码放入 .yard_templates/whatever-you've-call-this-dir/default/module/setup.rb

def init
  super
  sections.delete(:box_info)
end

要删除其他信息，请从 Yardoc gem 中获取 templates/default/layout/html/headers.erb 的副本，然后将其放在 .yard_templates/whatever-you've-call-this-dir/default/layout/ html/headers.erb 并编辑您需要的内容。

于 2012-12-09T02:33:47.193 回答