0

我正在使用 Ruby on Rails 3.0.7,我想安装和使用新的 RDoc 模板(而不是默认模板)来记录我的应用程序。

我想选择以下之一:

所以,

  1. 我在哪里可以获得上述模板之一?
  2. 我怎样才能安装它?
  3. 我应该在.rake文件中放入什么代码来使用所选模板生成文档?

简而言之,我是这方面的新手。


此时,在我的 Gemfile 中,我声明了以下内容:

gem "rdoc", "~> 3.6.1"

并运行bundle install命令。


更新@dmarkow

我安装了horo.rake gem 并在我的文件中插入了以下代码

  RDoc::Task.new do |rdoc|
    rdoc.title    = "My Awesome docs"
    rdoc.rdoc_dir = 'doc'

    rdoc.options << '-f' << 'horo'
    rdoc.options << '--main' << 'README'
  end

如果我运行命令rdoc -f horo --main README.rdoc *.rdoc lib ext,我会得到:

file '*.rdoc' not found
file 'ext' not found
uh-oh! RDoc had a problem:

Directory doc already exists, but it looks like it isn't an RDoc directory.

Because RDoc doesn't want to risk destroying any of your existing files,
you'll need to specify a different output directory name (using the --op <dir>
option)

如果我运行命令rake doc:app,我会得到:

WARNING: Deprecated reference to top-level constant 'Task' found at: <my_application_projectfolder>/Rakefile:7:in `<top (required)>'
    Use --classic-namespace on rake command
    or 'require "rake/classic_namespace"' in Rakefile
rake aborted!
wrong number of arguments (0 for 2)

@dmarkow更新二

我删除了doc目录:

如果我运行命令rdoc -f horo --main README.rdoc *.rdoc lib ext,我会得到:

file '*.rdoc' not found
file 'ext' not found

No newer files.

Files:      0

Classes:    0 (0 undocumented)
Modules:    0 (0 undocumented)
Constants:  0 (0 undocumented)
Attributes: 0 (0 undocumented)
Methods:    0 (0 undocumented)

Total:      0 (0 undocumented)
  0.00% documented

在文档目录中,它创建一个created.rid文件。

如果我运行该命令rake doc:app,我会得到与以下 UPDATE 相同的结果。

我必须做什么?我还需要保留gem "rdoc", "~> 3.6.1"在我的 Gemfile 中吗?

4

2 回答 2

1

我更喜欢汉娜,或者汉娜新风格。Hanna 很好,但它基于旧的 rdoc 版本。Hanna-nouveau 基于原始 Hanna,但它适用于 rdoc 3(使用 rdoc 3.12 测试)。

看起来 汉娜的例子

您可能会在http://gems.rubypla.net/todonotes/0.1.0/中看到另一个示例

详细信息可以在https://github.com/rdoc/hanna-nouveau找到。自述文件包含有关安装和使用的信息。


2014 年更新

Hanna-nouveau 不适用于 rdoc 4。

你可以做什么:安装一个旧的 rdoc 版本(我使用 3.12)。无需卸载最实际的版本。您可以调用 rdoc 版本,具体取决于:

rdoc _3.12_ -f hanna [...more options...]

_3.12_加载了 rdoc-version 3.12 。使用-f hanna新汉娜风格。

于 2011-11-12T21:04:12.377 回答
0

http://api.rubyonrails.org使用的是“Horo”模板。你可以在这里找到它,以及使用它的说明(它是通过 gem 安装的):

https://github.com/tenderlove/horo

于 2011-06-15T20:51:42.980 回答