rdoc için ana dosya olarak bir işaretleme dosyasını nasıl kullanırım (bir ray projesinde)?

Question

Rails projesi olan bir readme.md dosyası kullanmak mümkün mü ve rdoc ana sayfayı kullanıyor mu? Komisyon görevimi şu şekilde ayarlamayı denedim, ancak oluşturulan index.html sayfasının yer tutucu bir cümle var. README.rdoc olarak değiştirirseniz, dosyanın içeriğini içerdiği beklendiği gibi çalışır.

Ayrıca, tomdoc'u kullanmayı düşünüyorum.

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 

Answer 1

Gerçekten sorununuza bir cevap değil, ama iyi bir alternatif istiyorsanız:

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

sanırım:

kullanım YARD

ve bu ipuçlarını kullanın Github uyumlu olmak için README.md kullanmak istiyorum, ben genellikle aynı sorun var. bu yüzden bu iyi bir alternatif. Personality, ruby ​​kodumu belgelemek için YARD'ı tercih ediyor, daha güçlü ve aslında rubygems ile tamamen uyumlu, tercih edilen yol.

senin Rakefile büyütmek için ver:

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 

(sizin Gemfile güncellemek)