私の最初のgemをrubygems.orgにプッシュして実験し、そのオンラインドキュメントを生成する方法を見つけようとしています。ほとんどのgemの「show」ページでは、「Documentation」リンクをクリックすると、http：//rubydoc.info/gems/gemname/version/framesに移動します。これは、適切な場所でドキュメントを生成した場合に自動的に発生するものですか？gemspecで何かを指定する必要がありますか？ありがとう！
1536 次
2 に答える
3
rubydoc.infoは、gemのAPIドキュメントを自動的に生成します。少なくとも、これらのドキュメントには、すべてのクラス、モジュール、メソッドの署名、および各メソッドとクラスの前に配置したコメントが含まれます。
ファイルにyardocマークアップを追加すると、ドキュメントが改善されます。メソッドのヤードマークアップを少し示します。
# Validate the value.
# @param long_mailer_id truthy if the mailer ID is long (9 digits).
# @raise ArgumentError if invalid
def validate(long_mailer_id)
rubydoc.infoが使用するドキュメントエンジンであるyardocは、特定の形式のコメントを探し、それらを洗練されたドキュメントにフォーマットします。
README.md宝石のルートに、マークダウン形式でを追加することもできます。これはフォーマットされ、ドキュメントの「メインページ」として使用されます。
于 2013-02-28T03:20:46.190 に答える
2
RubyDocコミュニティの誰かから受け取った応答は次のとおりです。
やあ、
新しいgemは、RubyGemsのマスターgemリストに入るまでに最大1日かかる場合があります。これについてできることはあまりありません。それ以降、gemの新しいバージョンがリストに入力されるまで約1時間です（コピーを更新するために*：15にcronジョブを実行します）。
それは十分な時間を経過させることの問題でした。
于 2013-03-04T02:19:55.500 に答える