如何从Yardoc输出中删除继承信息(和其他部分)

时间:2012-11-21 12:15:51

标签: ruby templates template-engine yard

我想制作一些公开提供的文档,因此我希望删除Yard默认生成的输出的某些方面。我已经设法删除了源代码及其链接,但我还想删除:

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

我通过添加以下内容删除了源代码:

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

到路径.yard_templates / no_source / default / method_details / setup.rb并在生成时引用它。 (感谢this answer

尽管维护人员试图使用documentation on templates这样做很有帮助,但我还是看不到如何做到这一点。

我已经尝试查看输出并向后工作,并通过检查上面的代码中的sections但我看不出如何计算HTML输出中的哪个部分由代码中的内容表示?

非常感谢任何帮助或见解。


编辑:我已经找到了如何删除继承信息:

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

1 个答案:

答案 0 :(得分:0)

删除“班级列表”| “方法列表”| “文件列表”菜单:

将以下代码放入.yard_templates / whatever-already-called-this-dir / default / layout / html / setup.rb

def menu_lists
  []
end

删除继承信息:

将以下代码放入.yard_templates / whatever-already-called-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-already-called-this-dir / default /layout/html/headers.erb并编辑你需要的东西。