问题标签 [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.

212 问题
Newest
Active
Bountied
318
Unanswered
0 投票
2 回答
265 浏览

rdoc - 最好的“经典”RDoc 版本？

我想生成带有工作超链接的经典 4 面板框架 RDoc 格式。关于安装哪个 RDoc 的任何建议？

我的 ruby​​ 1.8.6 安装有一个生成 4 面板格式的 RDoc，但文件没有超链接。我的 ruby​​ 1.9.2 安装生成了非框架 Darkfish 格式，这不是我想要的。我尝试在我的 1.9.2 安装中安装旧版本的 RDoc，但不知何故我总是得到 Darkfish 格式。我应该使用 rdoc 命令标志来防止这种情况吗？

0 投票
3 回答
2437 浏览

ruby - 可以将 Bundler 配置为安装 gems rdoc 吗？

我使用bdoc（使用Hanna进行格式化）作为查看系统上安装的 gem 的 rdoc 文档的快速方法。但是，由于 bundler 在安装 gem 时不安装 rdoc，所以每当我开始使用新的 gem 或更新现有的 gem 时，我都不得不手动生成它们。

有谁知道在安装 gems 时是否有一种方法可以配置 bundler 以使其安装 rdoc 以避免我不得不手动执行？我在捆绑器源代码和配置手册中都看不到任何提及。

0 投票
2 回答
2115 浏览

ruby-on-rails - 生成 RDoc 失败，目录 .ext/rdoc 已存在

我只是在安装 Ruby Enterprise，无法更改 Ruby Enterprise 安装程序调用的这个崩溃命令的输出目录。

那么如何删除目录以满足此异常：

生成 RDoc 文档 ./miniruby -I./lib -I.ext/common -I./- -r./ext/purelib.rb ./runruby.rb --extout=.ext -- "./bin/rdoc " --all --ri --op ".ext/rdoc" "。"

目录 .ext/rdoc 已经存在，但看起来它不是 RDoc 目录。因为 RDoc 不想冒险破坏任何现有文件，所以您需要指定不同的输出目录名称（使用 --op 选项）。

0 投票
2 回答
693 浏览

ruby-on-rails - Rails 在 Ubuntu 10.10 上安装失败

我正在尝试在 Ubuntu 10.10 上安装 rails，但每次都得到 File not found: lib 。Ruby 和 Rubygems 已正确安装。我在网上看到过这个问题，但没有任何解决方案适合我。我重新安装了 rdoc，我仍然得到相同的结果。

0 投票
1 回答
78 浏览

ruby - 安装 gem 后是否可以生成 Rdocs？

我使用标志安装了一个 gem，--no-rdoc但现在我很后悔！

我可以以某种方式生成我的 rdocs 而无需重新安装 gem 吗？

0 投票
3 回答
1176 浏览

css - 如何自定义 rdoc Darkfish 样式表？

我正在使用 Rake 为我的项目生成 RDoc 文档，但我真的很讨厌 Darkfish 似乎生成的灰度样式。我对其他一切都很满意，我只是想让配色方案更具可读性。

这是我的 rake 任务：

我已经尝试添加'--style', 'doc/rdoc.css'到rd.options上述内容，但它抱怨这--style是一个未知选项并忽略它。我似乎找不到任何关于如何自定义模板或 css 等的文档；我只需要忍受 Darkfish 认为看起来不错的东西吗？

0 投票
1 回答
1491 浏览

vim - Vim JSDoc、PHPDoc、JavaDoc、RDoc 信息

这是交易，

如果您使用过 Aptana、Eclipse 甚至 Microsoft Expression Web 编辑器，那么您已经看到它们具有气球文本或Intellisense 弹出窗口，显示内置和自定义对象、方法等的提示/信息。

他们通过 JSDoc、PHPDoc、JavaDoc、RDoc 等获取信息。

我想在 Vim 中获得这些功能，可能实现为omnicompletion，而且因为 Mac/GVim 也支持气球文本，这也是。

0 投票
6 回答
406 浏览

ruby - 在本地访问基于 ruby​​ 的 gem 文档的简单方法是什么？

我有一堆我使用的 gem，但经常断开连接，并且希望能够在本地提取有关 gem 的文档。

到目前为止，我唯一能做的就是去 gem 库并找到 README。

有没有更好的方法可以在本地显示自述文件和完整文档而无需访问 web/github？

0 投票
2 回答
269 浏览

ruby - 为本地安装的 gem 生成 RDOC

我正在努力为我最近感兴趣的一颗宝石做出贡献——内斯塔。开发人员在创建您能找到的最轻、最薄的 CMS 之一方面做得很好，我想记录下来。据我所知，我已经通读了代码并评论了一些方法。

但是，我试图通过gem server在将其推送到网上之前调用并查看我的机器上的更改来在本地对此进行测试。

我尝试过的事情：

  1. 手动编辑。
    • 记录了文件。
    • 火了起来gem server。
  2. 使用该gem工具。
    • 记录了文件。
    • 冉gem rdoc nesta --rdoc
    • 重新启动gem server

一切都无济于事。请帮忙。
谢谢你。

0 投票
1 回答
724 浏览

ruby - RDoc 不生成源文件

我将 Rdoc 2.58 与 Ruby 1.9.2p138 一起使用。当我使用 Darkfish 格式（这是唯一的选择）生成我的 rdoc 文件时，我没有得到源代码预览。没有错误消息，并且正在为所有类生成 HTML 文件。

我已经尝试更新 gem 并阅读帮助文件，但我没有看到任何解决此问题的方法。

这是一个已知的问题？我还能尝试什么？

更新：

示例代码：

Rdoc 2.5.8 输出

源代码不会在生成的 rdoc 中切换。

Rdoc 3.5.3 输出

源代码确实在 html 输出中切换。


12345678910