问题标签 [rdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
ruby-on-rails - 没有要加载的文件 -- rdoc/task
当我跑
我收到此错误
这是--trace
我安装了 rake 0.9.2 和 rdoc 3.11。我在我的应用程序目录中运行这些命令。
ruby - 如何使用 RDoc 标记呈现逐字/代码/前置加号？
使用 RDoc 标记并使用 Yard 生成文档，我正在尝试记录一些具有如下行的命令输出：
...但无法弄清楚如何实现这一目标。我怎样才能得到 HTML：
我确定我错过了文档中的一些琐碎内容......
尝试#1
在不试图逃避标记的情况下，我缩进了这 2 个空格（就像任何其他代码/预块一样）：
...生成文档，并获取 HTML（如预期的那样，我想）：
尝试#2
如果我使用反斜杠转义，则此标记：
...变成这个 HTML：
尝试#3
奇怪的是，如果我连续使用两个加号，这个标记：
...变成这个 HTML：
尝试#4
使用 unindented<tt>只会给我留下一个非“逐字”（即 pre/code）部分；只是纯文本（再次，正如预期的那样，我想）：
...变成这个 HTML：
尝试#5
使用 indented<tt>会改变这个标记：
...进入这个 HTML：
ruby - 安装 RDoc 文档时出错：不兼容的编码正则表达式匹配
上周，在一些 gem install 或 gem update 操作中，我收到了类似以下的错误：
相似地：
可能还有另一个地方。我已经阅读了此内容，但没有找到我未编写的代码和我无法控制的数据的解决方案。知道如何解决这个问题吗？
ruby - 在 RDoc 中包含本地图像
我创建了一个带有“可视”工具的图像，我想将它包含在我的 rdoc 文档的首页上。首页在 *.rdoc 中定义。我发现可以包含外部图像，但如何包含本地图像？
更新：解决方法是为不带双引号的图像添加 html：<img src=../../images/overview.jpg>如果图像位于根目录的 images 文件夹中。（假设为同一文件夹中的某个文件夹生成 rdoc。）正确的/>结尾也不起作用。被/添加到 url。
ruby - 自定义 RDoc::ClassModule#description
我正在尝试为 RDoc 编写一个新的生成器，但我无法弄清楚如何自定义对象的description输出RDoc::ClassModule。目前它看起来像这样：
我想将“Gist”的链接自定义为不同的东西，例如#!/search/Octopi::Gist而不是只是Gist.
我该怎么做呢？
ruby-on-rails - 如何使 README_FOR_APP 的内容出现在 doc/app/index.html
我希望 的内容doc/README_FOR_APP出现在 中doc/app/index.html，当我这样做时rake doc:app。
目前，内容为：
这是 Rails 应用程序文档的 API 文档。
要查看，我必须在左侧的页面列表中README_FOR_APP单击。README_FOR_APP
我已经查看了如何重命名或移动 Rails 的 README_FOR_APP但 OP 断言他已经看到了我想要的行为。
我正在使用导轨 3.1.3。
ruby-on-rails - Rails：如何解决“rake/rdoctask”已弃用“警告？
只是一个警告：我是一个rails noob。
当我运行时：
我收到此弃用警告：
我正在使用：
- 导轨 3.0.1
- 耙 0.9.2.2
- RSpec 2.0.1
- RDoc 3.12
如果我卸载 rake 0.9.2.2 并使用 0.8.7 没有警告，但我宁愿不将其视为解决方案。
在谷歌搜索之后，许多网站说我需要更新我的 Rakefile 中的一行（基本上将 require 'rake/rdoctask' 更改为 require 'rdoc/task'）。但是，我的 Rakefile 看起来像这样：
没有需要替换的语句。当我添加 require 'rdoc/task' 时，它没有效果。当我在项目中搜索已弃用的“rake/rdoctask”时，没有结果。那么为什么 Rails 会抱怨呢？
编辑：不确定是否重要，但这是我的 gemfile：
ruby - 一无所知...当使用 ri 数组时——Ruby
我有 Ubuntu 11.10，并且正在使用 rvm 和 ruby 1.9.2。我完全按照这个来安装 Ruby：http: //blog.sudobits.com/2011/10/27/how-to-install-ruby-on-rails-in-ubuntu-11-10/
我生成文档
这似乎适用于一次性终端会话，但是一旦我退出并重新开始，我必须再次生成文档，否则我会收到 Nothing is Known 错误这需要很长时间，所以我宁愿不必每次启动终端会话时生成文档。
我可以做些什么来永久拥有可用的文档吗？
肯定有类似的问题——但我没有生成文档的问题，或者使用它们，只是保持它们的安装。
class - 如何在 RDoc 中排除模块但包含该模块的类
对于一些空白的模块，运行 RDoc 没有意义。例如：
RDoc 生成报告：
如何获取从报告生成中为空白的删除模块名称？
任何帮助将不胜感激，谢谢。
ruby - 使用 YARD 进行 Ruby 文档的内部注释？
我正在将我维护的 rubygem 从 RDoc 切换到 YARD 文档。但是，代码中有一些重要的注释只需要保留在代码中，不应该出现在文档中。例如：
RDoc 尊重#--和#++门，但 YARD 没有。在 YARD 的标记中做类似事情的语法是什么（如果存在）？