问题标签 [rdoc]

在 Ioke doc 中，ISpec 测试包含在文档中，请参阅 ioke.org/dok/index.html

Ruby 的 RSpec 和 RDoc（或 SDoc）如何做到这一点？我找不到任何命令行开关或外部库来这样做。有什么想法（不包括我自己实现它;-)）？

我在 Apache/passenger 中运行了一些 rails/rake 应用程序，我想将由这些应用程序提供的文档应用程序添加gem server到这些应用程序中，所以我可以轻松地给它一个特殊的（子）域，比如 docs.example.org，所以它是我们团队的所有成员都可以轻松使用，没有人需要自己启动服务器或记住端口号（如 8808，默认gem server端口）。

如果我在对象空间中有一堆类并且有一个也从对象空间生成的方法列表，是否有可能获取单个方法的 rdoc 文档？

例子：

文件：foo.rb

文件：baz.rb

总之，我正在使用 rdoc 为包含 C 扩展的 Ruby 代码生成文档，但是我的方法参数有问题。Rdoc 没有正确解析它们的名称，而是使用 p1、p2 等。

因此，首先，我的扩展实际上是编译为 C++，所以我必须使用如下所示的函数定义：

看起来 rdoc 需要像这样的旧式“C”定义：

无论如何我可以完成这项工作吗？

我是doxygen的忠实粉丝，多年来我一直使用各种语言。特别是，我很欣赏它类似于 wiki 的能力，可以包含图像并运行 Graphviz 点生成器，以从内联 DOT 代码或外部文件中获得任意内联图。

RDoc具有使用 Graphviz 生成类图的图表支持，但我看不到任何包含任意图像或图表的方法。它似乎也不支持建立像氧气这样的任意页面。

是否有任何工具可以为 Ruby 提供这些 Doxygen 风格的功能？

我浏览了 Ruby Toolbox工具列表，它们似乎都是 RDoc 的变体。

目前对我来说最可能的解决方案似乎是扩展 Yard。

我可以

和

两者都给了我很好的文档。

但

几乎什么也没给我，因为 Rails gem 本身实际上只是其他人的持有人。如何生成等效的http://api.rubyonrails.org/？

我正在尝试在我的 YARD 文档中创建一些链接。我可以得到一个 HTTP 链接：

呈现为

但是一个电子邮件链接：

给我一个警告：

并呈现为

我已经尝试了链接的常规 RDoc 语法：

但 YARD 似乎忽略了这一点。有谁知道更可靠的语法？

我想通过 gem 服务器在本地阅读 Rails 文档。

我去

我尝试卸载并重新安装 Rails，但没有任何效果。

所有其他 gem 都可以正常工作，为什么我看不到 Rails 文档？

我正在尝试使用 XML 格式生成 RDoc。这是我正在使用的命令：

文件已创建，但未生成方法列表。我正在使用rdoc (2.4.3). XML 的 RDoc 模板包括用于显示方法的标记。

是否可以？

可能重复：
ruby 1.9 ri 问题

当我尝试ri在命令提示符窗口中使用 Ruby 的工具来获取有关类、方法等的帮助时，它似乎总是失败。例如，如果我输入：

我收到一条消息说：

我正在使用安装了 Ruby 1.9.1p243（2009-07-16 修订版 24175）[i386-mingw32] 的 Vista 64。

我应该怎么做才能配置 ri工作？