كيف يمكنني تمكين زر "انقر للتبديل مصدر" في Ruby RDOC؟

Question

عند استخدام مولد RDOC Darkfish لإنشاء وثائق RDOC ، بجانب الأساليب هناك أ Click to toggle source زر بجوار كل طريقة. لا يعمل لي عندما أقوم بإنشاء وثائق ، فكيف تحصل على هذه الميزة للعمل ، هل يتعين عليك إضافة كلمة رئيسية إلى مصدر RDOC الخاص بك أو شيء من هذا القبيل؟

Answer 1

واجهت نفس المشكلات ووجدت الملفات المفقودة في http://rack.rubyforge.org/doc/js . قمت بنسخها يدويًا في مستند/تطبيق/JS Dir والآن انقر لتبديل المصدر يعمل. هذا هو على الأقل حل سريع.

Answer 2

يبدو أنه تم تمكينه افتراضيًا. لقد حاولت للتو اختبارًا سريعًا مع RDOC v2.5.11:-

$ mkdir temp
$ cd temp
$ cat temp.rb

class MyClass
  def my_method; end
end

$ rdoc
Parsing sources...
100% [ 1/ 1]  temp.rb                                                           

Generating Darkfish...

Files:         1
Classes:       1 (    1 undocumented)
Constants:     0 (    0 undocumented)
Modules:       0 (    0 undocumented)
Methods:       1 (    1 undocumented)
  0.00% documented

Elapsed: 0.1s
$ open doc/index.html

عندما أنقر على الرابط ل #my_method وأنا أحوم على وصف الطريقة ، أرى رابط "انقر إلى Toggle Source" وهو يعمل عند النقر فوقه.

ستحتاج إلى تمكين JavaScript في متصفحك لجعل هذا العمل.

Answer 3

أواجه نفس المشكلة مع رمز Rails3. إنه عام جميل ولا أتذكر اللعب مع إعداد RDOC ، لكن بلدي click to toggle source لا يعمل أيضًا. أعلم أنه تم تشغيل JS ولم يكن أي أخطاء عند الركض rake doc:app لذلك لست متأكدًا مما يحدث.

الشيء الوحيد الذي يمكنني التفكير فيه هو أنني أقوم بتشغيل Ruby 1.9.2 / Rails 3.0.0 تحت RVM. هل هذا يحدث فرقا؟

تحديث: لقد لاحظت أنه يحاول تحميل ملفات JavaScript غير الموجودة من أ js الدليل. هل من المفترض أن تقوم RDOC بإدخال ملفات JS أم أنك من المفترض أن تفعل ذلك يدويًا؟

Answer 4

هذه مشكلة في إصدارات قديمة من RDOC تعمل مع RVM. واجهت نفس المشكلة مع الإصدار 2.5.8. يحتوي Path to the Templates Directory على .rvm ، لذلك لا يتم نسخ الصور ودليلات JS في وثائق تم إنشاؤها. كإصلاح ، يمكنك تغيير هذا السطر من الكود في ملف lib/rdoc/generator/darkfish.rb

next if path =~ /#{File::SEPARATOR}\./

ل

next if path =~ /#{@template_dir}.*#{File::SEPARATOR}\./

بفضل جيريمي بوب (لاكتشاف مصدر هذه القضية - http://rubyforge.org/tracker/index.php؟func=detail&aid=28482&group_id=627&atid=2472) وجوردون Thiesfeld (لإعطاء الحل - http://rubyforge.org/tracker/؟func=detail&atid=2472&aid=26923&group_id=627) من Rubyforge.com