tạo Rdoc cho ứng dụng đường ray

Question

Tôi muốn tạo tài liệu cho dự án đường ray (2.3.8) của mình. Khi tôi cố gắng

rake doc:rails 
rake doc:rerails 

Nó tạo ra tài liệu cho tất cả các lớp bao gồm lớp ruby ​​tiêu chuẩn và tất cả các file trong thư mục ruby ​​nhà cung cấp (các plugin vv ..)

Làm thế nào tôi có thể tạo tài liệu rdoc chỉ cho các lớp ruby, tập tin trong thư mục sau

1. ứng dụng thư mục (tất cả các mô hình, điều khiển và lượt xem)
2. cấu hình thư mục
3. thư mục lib

Answer 1

Tôi đã thêm phần này vào Rakefile của mình;

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

    rdoc.rdoc_files.include("README.rdoc", "doc/*.rdoc", "app/**/*.rb", "lib/*.rb", "config/**/*.rb") 
    #change above to fit needs 

    rdoc.title = "App Documentation" 
    rdoc.options << "--all" 
end 

Sau đó chạy;

rake rdoc 

Kiểm tra các rdoc :: tài liệu công tác để biết thêm http://rdoc.rubyforge.org/RDoc/Task.html

Phải thừa nhận rằng tôi đang trên một đường ray 3 ứng dụng, nhưng tôi nghĩ rằng công trình này giống nhau.

Answer 2

Bạn có thể sử dụng rake doc:app để tạo tài liệu cho ứng dụng.

Trích dẫn từ mục 2.4 của Rails guides:

Các doc: namespace có các công cụ để tạo ra tài liệu cho ứng dụng của bạn, tài liệu API, hướng dẫn. Tài liệu cũng có thể bị tước , chủ yếu hữu ích cho việc giảm bớt mã số của bạn, như thể bạn đang viết một ứng dụng Rails cho một nền tảng được nhúng.

rake doc: ứng dụng tạo tài liệu cho ứng dụng của bạn trong doc/app. rake doc: các hướng dẫn tạo các hướng dẫn Rails trong doc/guide. rake doc: rails tạo tài liệu API cho Rails trong doc/api.