问题标签 [rdoc]

如何更改我的 gem 环境的默认 RDoc 模板。

我希望我的 gem 服务器看起来像这样的 RDoc：http://getcloudkit.com/api/并且我已经看到了这种设计，所以这不应该那么困难。

我想知道在我可以导航的单个文件中为 rails、它的插件和应用程序生成文档的最佳选择是什么。我一直在使用 rdoc，但它创建了多个文件，院子太慢了，汉娜卡在随机的地方。有什么帮助吗？

我在我的 Rails 项目中使用YARD，想知道如何在 Rails 模型上记录继承/运行时方法？例如记录模型first_name上某个属性的存在。User

我有一系列 Ruby 方法，我想将它们的返回值转储到格式化的报告中。但是，我还想对这些结果进行注释（即描述值是什么），我想知道是否可以使用每种方法的现有注释来进行注释？

所以我想我想要做的是正常输出 rdoc，但是对于每个方法，实际运行带有参数的方法。每个方法的参数都是相同的，这简化了它。

这些错误是什么意思？

还有这个

我已经使用“yum install ruby​​-rdocs”安装了 rdocs。但我不明白这个错误是什么意思

例如，我总是看到方法被称为String#split, 但从不String.split，这似乎更合乎逻辑。甚至可能String::split，因为您可以考虑#split在String. 当类被假定/隐含（）时，我什至单独看到了该方法#split。

我知道这是在 ri 中识别方法的方式。哪个先出现？

这是为了区分例如方法和字段吗？我还听说这有助于区分实例方法和类方法。但这是从哪里开始的呢？

我在多个位置安装了几个 gem。

生成/重新生成的硬/简单方法是什么：

• 所有这些已安装的 gem 的 rdoc，一次？
• 所有这些已安装的 gem 的 yardoc 一次？

我gem install rails -v=2.3.8用来安装rails，它说rdoc和ri已经生成。

但是当我gem server，我无法在浏览器中打开 rails doc，它说doc_root/rails-2.3.8/rdoc/index.html not found

我看了看/usr/local/lib/ruby/gems/1.8/doc/rails-2.3.8/rdoc，发现是空的。

如何解决？如何通过 gem 生成 rdoc？

我正在运行 rdoc 2.5.9，当我使用默认的“Darkfish”模板生成 rdoc 时，只需运行：

在我的 Rails 根文件夹中。所有文件都已生成，但 doc 目录中缺少“images”和“js”文件夹。所以我需要手动复制它们。

我有以下版本：

我是否需要指定更多命令行参数才能复制这些文件夹？

每当我安装 gems 时，我都会看到 ri 和 rdoc 紧随其后。我知道这是文档，但是两者之间有什么区别以及如何使用它们？