Wie kann ich aktivieren „klicken Sie auf das Toggle-Quelle“, um in Ruby RDoc?

Question

Wenn die Darkfish RDoc Generator RDoc Dokumentation zu erzeugen, da neben Methoden ist eine Click to toggle source Taste jede Methode nächsten. Es ist nicht für mich zu arbeiten, wenn ich meine Dokumentation zu erzeugen, so wie bekommt man diese Funktion zu arbeiten, tun Sie ein Schlüsselwort in Ihre RDoc Quelle oder etwas hinzufügen haben?

Answer 1

Ich hatte die gleichen Probleme und fanden die fehlenden Dateien unter http://rack.rubyforge.org/doc / js . Ich kopierte sie manuell in einem doc / app / js dir und jetzt Klicken Sie auf Toggle-Quelle funktioniert. Dies ist zumindest eine schnelle Lösung.

Answer 2

Es scheint standardmäßig aktiviert sein. Ich habe gerade versucht, einen schnellen Test mit 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

Wenn ich auf den Link für #my_method klicken und ich schweben über die Beschreibung des Verfahrens, ich sehe die „Click-to Toggle Quelle“ -Link und es funktioniert, wenn ich es klicken.

Sie müssen Javascript in Ihrem Browser aktivieren, damit diese Arbeit zu machen.

Answer 3

Ich habe das gleiche Problem mit meinem Rails3 Code. Es ist ziemlich allgemein und ich erinnere mich nicht mit dem RDoc Setup zu spielen, aber meine click to toggle source entweder nicht funktioniert. Ich weiß, dass JS eingeschaltet ist und ihre Fehler nicht gewesen sein, als ich rake doc:app laufen, so dass ich bin mir nicht ganz sicher, was los ist.

Das einzige, was ich denken kann, ist, dass ich bin mit Ruby-1.9.2 / Rails 3.0.0 unter RVM. Macht das einen Unterschied?

UPDATE: Ich habe bemerkt, dass sein Versuch nicht existent Javascript-Dateien von einem js Verzeichnis zu laden. Ist RDoc soll die JS-Dateien einfügen oder soll man es manuell tun?

Answer 4

Das ist ein Problem in einer alten Versionen von rdoc, die zusammen mit rvm arbeiten. Ich hatte dasselbe Problem mit 2.5.8-Version. Der Pfad zum Vorlagenverzeichnis enthält .rvm, so dass die Bilder und js Verzeichnisse nicht in generierte Dokumentation kopiert werden. Wie zu beheben, können Sie diese Codezeile in lib ändern / rdoc / Generator / darkfish.rb Datei

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

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

Dank Jeremy Bopp (für die Quelle des Problems entdeckt - http://rubyforge.org/tracker/index.php?func=detail&aid=28482&group_id=627&atid=2472 ) und Gordon Thiesfeld (für Lösung geben - http://rubyforge.org/tracker/?func=detail&atid=2472&aid=26923&group_id=627 ) von Rubyforge.com