2012-11-21 45 views
0

我想生成一些公開可用的文檔,因此我希望刪除默認情況下Yard生成的輸出的某些方面。我已經設法刪除源代碼及其鏈接,但我也想刪除:如何從Yardoc輸出中刪除繼承信息(和其他部分)

  • 類名。
  • 繼承信息。
  • 「在...中定義」信息。
  • 如果可能的話,「Class List」| 「方法列表」| 「文件列表」菜單。

我通過添加除去源:

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

到路徑.yard_templates/no_source /默認/ 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 

回答

0

取出 「類名單」 | 「方法列表」| 「文件列表」 菜單:

放入.yard_templates /下面的代碼什麼 - ......你所說,這-DIR /默認/佈局/ HTML /的setup.rb

def menu_lists 
    [] 
end 

刪除繼承信息:

放入.yard_templates /下面的代碼什麼 - ......你所說,這-DIR /默認/模塊/的setup.rb

def init 
    super 
    sections.delete(:box_info) 
end 

要刪除其他信息,從Yardoc gem中獲取templates/default/layout/html/headers.erb的副本,然後將它放在.yard_templates /任何你稱爲this-dir /默認/ layout/html/headers.erb並編輯你所需要的。

相關問題