如何向我的gem添加文档，这些文档将显示在rubygems.org上？

Question

尝试将我的第一个gem推送到rubygems.org，我正在试图弄清楚如何为它生成在线文档。对于大多数宝石的“展示”页面，当我点击“文档”链接时，我会被带到http://rubydoc.info/gems/gemname/version/frames。如果我在正确的位置生成文档，这会自动发生吗？我是否必须在gemspec中指定一些内容？谢谢！

Answer 1

以下是我从RubyDoc社区中的某个人那里收到的回复：

  

你好，

     

新宝石可能需要一天的时间才能成为RubyGems的主宝石   名单。关于这一点，我们无能为力。从那时起，它就是一个   您的宝石的新版本的小时将被填充到列表中（我们   在*：15运行一个cron作业来更新我们的副本。）

这是让时间过去的问题。

Answer 2

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)

<yardoc，rubydoc.info使用的文档引擎，将以特定格式查找注释，并将其格式化为spiffy文档。

您还可以在您的gem的根目录中添加Markdown {{3}}格式的README.md。这将被格式化并用作文档的“主页”。