2

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

这是我的 rake 任务：

Rake::RDocTask.new do |rd|
    rd.main = "README.rdoc"
    rd.title = "My Title"
    rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
    rd.options = ['--main', 'README.rdoc']
end

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

4

3 回答 3

1

如果您查看 Darkfish 模板，您将看到的唯一 CSS 引用是这样的：

<link type="text/css" media="screen" href="<%= rel_prefix %>/rdoc.css" rel="stylesheet" />

其中有些有rel_prefix，有些没有。任何模板中都没有包含其他样式表的内容。大概，您应该将您的颜色更改应用到rdoc.css模板或手动编辑模板，以在您的修改中包含另一个样式表。

更好的方法是--style为 Darkfish 提供补丁支持并向作者发送补丁。看起来您只需要在模板中添加一点额外的 erb、一些开关解析逻辑以及一个围绕 in 调用的新self.render_template变量lib/rdoc/generator/darkfish.rb。听起来这将是对 Darkfish 的有用补充，作者甚至可能很高兴有人想让他的软件变得更好。

于 2011-04-07T02:05:12.117 回答
1

难道你不能只获取darkfish 生成的.css 文件的副本，然后进行修改，并将其存储在硬盘上的单独目录中。然后在你的 rake 任务中，当 rdoc 完成时，只是覆盖 .css 文件？

于 2012-03-02T02:05:35.547 回答
0

Darkfish 通过 --template 'your_template_name' 提供模板支持；我相信这需要设置为一个 rdoc 插件 gem。

这也可能有所帮助：http: //fossplanet.com/f14/making-rdoc-template-gem-26986/

RDoc 插件 gem 表示具有如下目录结构的 gem：

./lib/rdoc/generator/template/#{your template name and files copied from rdoc-2.blah/lib/rdoc/generator/template/darkfish}

和

./rdoc/generate.rb将上述模板目录添加到 $LOAD_PATH。( $LOAD_PATH.unshift(File.expand_path(File.join(Dir.pwd,'..','lib', "#{..... and so on}")

于 2011-04-08T14:56:21.707 回答