問題タブ [yard]

# -*- encoding : utf-8 -*-Rails アプリのすべての Ruby ファイルの先頭に魔法のコメントがあります。つまり、各クラス定義の概要セクションにある私の YARD ドキュメントに表示されます。

省略できる方法はありますか？

私はRoRで2〜3年間働いていませんでしたが、今はビジネスに戻っており、このコマンドが本当に気に入っていbundleます。しかし、私の仲間の開発者が、厳密にはRailsアプリケーションの一部ではないすべてのgemをインストールしていることを確認する方法が少しわかりません。

たとえば、ドキュメントにはYARDを使用します。YARDは、私たちが取り組んでいるRailsプロジェクトとは何の関係もないので、Gemfileに追加する必要があるかどうかわかりません。一方、これは、すべての開発者が自動的にインストールすることを確認する唯一の方法です。

そして、それをGemfileに追加する場合、どの程度正確に行う必要がありますか？グループ内では:development、本番用にロードされませんか？ただし、厳密に言えば、開発時にロードするのではなく、手動で使用できるようにインストールするだけです。

では、どのように追加すればよいですか？みんな、助けてくれてありがとう。

Railsアプリのドキュメント化にYARDを使い始めたところです。特定のマークアップハンドラーを指定しませんでしたが、 `code`がに変換されることを期待していましたcodeが、これは発生しないようです。これは正常な動作ですか？これを機能させるには、いくつかのオプションを追加する必要がありますか？ありがとうございました。

doc/Railsプロジェクトのフォルダーを乱雑にしないようにYardに指示する方法はありますか？ファイルを保存したいのですdoc/yard/が。悲しいことに、私はそのためのオプションを見つけられませんでした。

助けてくれてありがとう。

彼らのウェブサイトのどこにも見つかりませんでした。

ここに私が持っているものがあります:

しかし、yardoc 生成を実行すると、次のエラーが発生します。

上記のドキュメントが書かれているAPIページに行くと、そのオブジェクトのページへのリンクではなく、プレーンテキストが表示されます。

ただし、上記のエラーは、このクラスが見つからなかったことが原因であると思われます。

(ただし、PageSection に変更すると、ドキュメントは問題なくレンダリングされます)。

多分それは私が使用しているヤードレストプラグインのバージョンと関係がありますか? わからない

複数の関数間で共有される多数のオプションを持つハッシュ構造を持つ、かなり基本的な yard マクロの使用法であると私が想定したものがあります。この構造をあちこちに複製する必要がないようにするためだけにマクロを使用したいと思っていましたが、そのようには機能しないようです。

私が期待していたのは：

h1 と h2 が正しく文書化されていること。少なくとも $1 は関数自体から取得するようには機能しないことがわかったと思いますが、両方のパラメーター h1 を呼び出し、マクロで $1 を h1 に置き換えることができますが、まだ欲しいものが得られません.

http://rubydoc.info/docs/yard/file/docs/Tags.md#macroの「単純なマクロの定義」の例は、私がこれを行うことができることを示していますどちらも機能していないようです）。

ヤードについてはよくわかりませんが、これはうまくいきませんか？私の結果を達成するためにできることはありますか？ヤードサーバーコンソールにエラーが表示されないため、これを説明するデバッグ機能はありますか?

ありがとう

RVM、Ruby v1.9.3-p125およびを使用してRuby on Rails v3.2.2います。Ubuntu サーバーにremotipart v1.0.2gem をインストールしようとしていますが、次のエラーが表示されます。

どういう意味ですか？remotipartgem は正しくインストールされていますか? どうすれば問題を解決できますか?

git commit ワークフローの一部として Ruby ドキュメントを自動生成するためのベスト プラクティスは何ですか? コミットがマスターにマージされるたびに、新しいドキュメントを自動的に生成したいと考えています。

ruby Twitter gem ソースコードをダウンロードし、.d 経由でインストールした yard を使用してドキュメントを生成しようとしていgem install yardます。rakefile で、次のものが見つかりました。これは、Twitter gem のドキュメントを生成するために使用されていると思われます。

私require yardはirbで実行しようとしましYARD::Rake::YardocTask.newたが、何も起こりませんでした。

正しい軌道に乗るのを手伝ってもらえますか?

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

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

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

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

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

出力を見て逆方向に作業してみましたがsections、上記のコードから調べてみましたが、HTML 出力のどのセクションがコードの何によって表されているかを調べる方法がわかりません。

どんな助けや洞察も大歓迎です。

編集:継承情報を削除する方法を見つけました: