0

公開されているドキュメントを作成したいので、Yard がデフォルトで生成する出力の特定の側面を削除したいと考えています。すでにソースコードとそのリンクを削除できましたが、次のものも削除したいと思います。

  • クラス名。
  • 継承情報。
  • 「で定義された」情報。
  • できれば「クラス一覧」 | 「方法一覧」 | 「ファイル一覧」メニュー。

以下を追加してソースを削除しました。

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

パス .yard_templates/no_source/default/method_details/setup.rb に追加し、生成時に参照します。（この回答のおかげで）

メンテナーがtemplates に関するドキュメントを使用しようとしているのと同じくらい役に立ちますが、これを行う方法がわかりません。

出力を見て逆方向に作業してみましたが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-called-this-dir/default/layout/html/setup.rb に入れます

def menu_lists
  []
end

継承情報の削除:

次のコードを .yard_templates/whatever-you've-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-you've-called-this-dir/default/layout/ に配置します。 html/headers.erb を開き、必要なものを編集します。

于 2012-12-09T02:33:47.193 に答える