रेल ऐप के लिए आरडीओसी बनाना

Question

मैं अपने रेल (2.3.8) प्रोजेक्ट में एक दस्तावेज जेनरेट करना चाहता हूं। जब मैं करने की कोशिश की

rake doc:rails 
rake doc:rerails 

यह मानक गहरे लाल रंग का वर्गों और विक्रेता निर्देशिका में सभी माणिक फ़ाइलों सहित सभी वर्गों के लिए प्रलेखन बनाता है (प्लगइन्स आदि ..)

मैं केवल गहरे लाल रंग का वर्गों के लिए rdoc प्रलेखन बना सकते हैं कैसे, निम्नलिखित निर्देशिकाओं में से फ़ाइलें

1. एप्लिकेशन फ़ोल्डर (सभी मॉडलों, नियंत्रकों और विचार)
2. config फ़ोल्डर
3. lib फ़ोल्डर

Answer 1

मैंने इसे अपने रेकैकाइल में जोड़ा;

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 

फिर चलाएं;

rake rdoc 

बाहर चेक के लिए RDoc :: टास्क डॉक्स अधिक http://rdoc.rubyforge.org/RDoc/Task.html

वैसे मैं एक रेल 3 एप्लिकेशन पर है, लेकिन मैं यह एक ही काम करता है लगता है।

Answer 2

आप ऐप के लिए दस्तावेज़ उत्पन्न करने के लिए rake doc:app का उपयोग कर सकते हैं।

Rails guides की धारा 2.4 से हवाला देते हुए:

डॉक: नाम स्थान उपकरण है अपने एप्लिकेशन, API दस्तावेज़, गाइड के लिए प्रलेखन उत्पन्न करने के लिए। दस्तावेज़ीकरण को भी हटाया जा सकता है जो मुख्य रूप से आपके कोडबेस को कम करने के लिए उपयोगी होता है, जैसे कि आप एम्बेडेड प्लेटफ़ॉर्म के लिए रेल एप्लिकेशन लिख रहे हैं।

रेक दस्तावेज़: ऐप दस्तावेज़/ऐप में आपके एप्लिकेशन के लिए दस्तावेज़ उत्पन्न करता है। रेक दस्तावेज़: गाइड डॉक्टर/गाइड में रेल गाइड उत्पन्न करता है। रेक डॉक: रेल डॉक/एपीआई में रेल के लिए एपीआई दस्तावेज उत्पन्न करता है।