ruby - 如何将文档添加到将显示在 ruby​​gems.org 上的 gem 中？

Question

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

Answer 1

rubydoc.info会自动为你的 gem 生成 API 文档。至少，这些文档将包含所有类、模块和方法的签名，以及您在每个方法和类之前放置的注释。

如果将 yardoc 标记添加到文件中，文档会变得更好。这是一个方法的一小部分 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是ruby​​doc.info使用的文档引擎，它将查找特定格式的注释并将它们格式化为漂亮的文档。

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

Answer 2

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

你好呀，

新宝石最多可能需要一天时间才能进入 RubyGems 的主宝石列表。我们对此无能为力。从那时起，大约需要一个小时才能将新版本的 gem 填充到列表中（我们在 *:15 处运行 cron 作业来更新我们的副本）。

这是一个让足够的时间过去的问题。