问题标签 [rdoc]

如何将 ruby​​ 代码文件按原样包含到 RDoc 中？

我有一个 example.rb 文件，它记录了如何使用我的 gem，我想将它作为 README.rdoc 和 HISTORY.rdoc 之类的文件之一包含在内。

我已经想出了如何使用语法 gem将 ruby​​ 源代码转换为 HTML，但我不知道如何在不解析文件的情况下让 RDoc 包含该文件。

当我告诉 RDoc 包含 html 文件时，它没有被列出，如果我通过使用 rdoc 或 txt 作为文件扩展名来伪造它，它不会正确显示（文件实际上仍然是 html）。

我有一个可行的解决方案，它非常丑陋。必须有一种更好的方法来做到这一点，它是 rdoc 原生的，但我没有看到。

这是我的 Rakefile 中的内容：

我正在尝试记录我在课堂上使用 RDoc 注释编写的一些 rake 任务，并且在表示方括号时遇到了麻烦。我想添加一些示例，说明如何使用参数运行我的 rake 任务，因此有一个像这样的 rdoc 行：

# 例如。rake build[MyProject]

问题是 RDoc 解析器转换创建一个链接而不是打印方括号。我尝试了各种转义序列： [ ; [[ ; ＃{[我的项目]} ; [我的项目] 但似乎没有任何效果。

有什么办法可以逃避这些方括号，使它们不会转换为链接？

谢谢，亚伦

我想将我的使用文档保存在自述文件（duh）中，而不是脚本顶部的注释。如何让 RDoc::usage 从自述文件中提取使用信息而不是脚本注释？

当我 gem server 并转到页面时，我注意到没有指向RDoc的链接，当我移动到那里时，弹出窗口说 RDoc 没有安装。

但是当我输入rdoc --help终端时，会有回复。如何获得 rdoc，因为我需要阅读omniauth rdoc？

我正在运行 ri 版本 2.5.8 和 ruby​​ 1.9.2。如果我尝试类似的东西ri Enumerable | less，则分页会减少。我看到了输出，但我不能使用 CTRL-F 或 CTRL-B 来回翻页和向前翻页。如果我尝试这样做，我只会在屏幕底部看到文字“^F”和“^B”字符输出。怎么了？

当我ri在命令提示符下键入时，它什么也不返回：

ri 已知的类和模块：

如何正确设置？非常感谢。

RDoc 具有 :include: 标记（参见本页底部），它将接收任意文本文件和格式，就好像它在包含开始的任何地方缩进一样。这是为文档示例提取源代码的好方法。

Yard是否有类似的标签或功能？

假设我有以下课程。

然后我通过 rdoc 运行它。

$ rdoc foo.rb

它生成：

我希望它生成这样的东西：

实现这一目标的最佳方法是什么？

我正在创作的 gem 没有任何类型的内联 ri/rdoc，因此当用户使用gem install它时，当 ruby​​gems 尝试编译文档时会收到警告：

我假设这是因为它试图针对我的应用程序的不存在的 lib 文件夹运行 ri 工具（gem 是所有二进制文件）。我怎样才能避免这个错误？我尝试将虚拟文件放入其中，lib/但这没有帮助。

我想让 fastri 引擎与捆绑器驱动的项目一起工作。任何人都知道如何做到这一点。