新しいRDOCテンプレートを取得してインストールします

StackOverflow https://stackoverflow.com/questions/6364141

質問

Ruby on Rails 3.0.7を使用しています。アプリケーションを文書化するために、新しいRDOCテンプレートを（デフォルトではなく）インストールして使用したいと思います。

次のいずれかを選択したい：

そう、

  1. 上記のテンプレートのいずれかをどこで入手できますか？
  2. どうすればそれをインストールできますか？
  3. どのコードを入れるべきか .rake 選択したテンプレートでドキュメントを生成するファイル？

いくつかの言葉で、私はこの問題の初心者です。

この時点で、私のgemfileでは、以下を述べました。

gem "rdoc", "~> 3.6.1"

そして、実行します bundle install 指図。

更新i 為に @dmarkow

インストールしました ホロ 宝石と私のコードを挿入しました .rake ファイル

  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)

更新II 為に @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

ドキュメントディレクトリでは、aを作成します created.rid ファイル。

コマンドを実行した場合 rake doc:app 次の更新と同じようになります。

私がしなければならないこと？私はまだ維持する必要があります gem "rdoc", "~> 3.6.1" 私のgemfileで？

役に立ちましたか？

解決

で使用されるもの http://api.rubyonrails.org 「Horo」テンプレートです。ここでそれを見つけることができます。それを使用するための指示（宝石を介してインストールされています）：

https://github.com/tenderlove/horo

他のヒント

私はハンナ、respハンナ・ヌーボーが好きです。ハンナは大丈夫でしたが、それは古いRDOCバージョンに基づいています。オリジナルのハンナに基づいてハンナヌーヴォーがありますが、RDOC 3で動作します（RDOC 3.12でテスト）。

これ ように見えます Example for Hanna

別の例が表示される場合があります http://gems.rubypla.net/todonotes/0.1.0/

詳細はで見つけることができます https://github.com/rdoc/hanna-nouveau. 。 readme インストールと使用に関する情報が含まれています。

更新2014

Hanna-nouveauはRDOC 4で動作しません。

できること：古いRDOCバージョンをインストールします（3.12を使用します）。最も実際のバージョンをアンインストールする必要はありません。 RDOCバージョンに応じて電話をかけることができます。

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

と _3.12_ RDOC-version 3.12がロードされます。と -f hanna Hanna-nouveauが使用されています。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top