Bir raylar uygulaması için Rdoc oluşturma

Question

Raylarıma (2.3.8) proje için bir doküman oluşturmak istiyorum. Ben

rake doc:rails 
rake doc:rerails 

Bu standart yakut sınıfları ve satıcı dizindeki tüm yakut dosyaları dahil tüm sınıfları için belgeler oluşturur çalıştığımızda (eklentileri vs ..)

Sadece yakut sınıfları için rdoc belgelerine nasıl oluşturabilirim, aşağıdaki dizinlerde dosyalar

1. uygulama klasörü (tüm modeller, kontrolörler ve görünümler)
2. config klasörü
3. lib klasöründe

Answer 1

Bunu, Rakefile'ma ekledim; Daha sonra aşağıdakileri çalıştırın;

rake rdoc 

http://rdoc.rubyforge.org/RDoc/Task.html

Kuşkusuz ben daha raylar 3 uygulama üzerinde

Kontrol dışarı için RDoc :: Görev dokümanlar, ama bu aynı şekilde çalışır düşünüyorum.

Answer 2

Uygulama için belge oluşturmak üzere rake doc:app'u kullanabilirsiniz.

Rails guides bölüm 2.4 alıntı:

doc: namespace sizin app, API belgeleri, rehberler belgelerine üretmek için araçlara sahiptir. Dokümantasyon ayrıca, gömülü bir platform için bir Rails uygulaması yazıyormuşsunuz gibi, temel olarak kod tabanınızı zayıflatmak için yararlı olan da kullanılabilir.

rake doc: uygulama, uygulamanızın belgelerini doc/app olarak oluşturur. rake doc: kılavuzlar dokümanlar/kılavuzlarda Kılavuz kılavuzları oluşturur. rake doc: rails , doc/api'deki Raylar için API belgeleri oluşturur.