8

Rails プロジェクトで readme.md ファイルを使用し、rdoc がそれをメイン ページで使用することは可能ですか? 以下のように rake タスクを設定してみましたが、生成される index.html ページにプレースホルダ文があります。README.rdoc に変更すると、ファイルの内容が含まれているため、期待どおりに機能します。

また、問題を複雑にしている可能性があると思われるtomdocを使用しようとしていますが、わかりません。

RDoc::Task.new :rdoc do |rdoc|
  rdoc.main = "README.md"

  rdoc.rdoc_files.include("README.md", "doc/*.rdoc", "app/**/*.rb", "lib/**/*.rb", "config/**/*.rb")

  rdoc.title = "My Documentation"
  rdoc.options << "--all"
  rdoc.options << "--line-numbers"
  rdoc.markup = "tomdoc"
  rdoc.rdoc_dir = "rdoc"
end
4

1 に答える 1

5

それは実際にはあなたの問題に対する答えではありませんが、良い代替手段が必要な場合:

ヤードを使用

このヒントを使用してください：

https://github.com/lsegal/yard/issues/404

README.md を使用して Github に準拠させたいと考えていると思いますが、私はしばしば同じ問題を抱えています。したがって、これは良い代替手段です。個人的には、Ruby コードを文書化するために YARD を好みます。YARD はより強力で、実際には ruby​​gems と完全に互換性があり、好ましい方法です。

あなたの Rakefile を拡大するためにそれを与えてください：

require "github/markup"
require "redcarpet"
require "yard"
require "yard/rake/yardoc_task"

YARD::Rake::YardocTask.new do |t|
  OTHER_PATHS = %w()
  t.files = ['lib/**/*.rb', OTHER_PATHS]
  t.options = %w(--markup-provider=redcarpet --markup=markdown --main=README.md)
end

バンドルすることを忘れないでください（Gemfileを更新してください）

于 2013-10-16T14:42:55.043 に答える