Come faccio ad attivare “Fare clic per scegliere origine” pulsante in Ruby RDoc?

StackOverflow https://stackoverflow.com/questions/3800704

  •  25-09-2019
  •  | 
  •  

Domanda

Quando si utilizza il generatore di RDoc Darkfish per generare la documentazione RDoc, accanto ai metodi c'è un pulsante Click to toggle source accanto a ciascun metodo. E non funziona per me quando ho generare la mia documentazione, così come si fa a ottenere che funzione per il lavoro, devi aggiungere una parola chiave nella vostra fonte RDoc o qualcosa del genere? alt text

È stato utile?

Soluzione

ho avuto gli stessi problemi ed ha trovato i file mancanti a http://rack.rubyforge.org/doc / js . Li ho copiati manualmente in un doc / app / js dir e ora Clicca per fonte di commutazione opere. Questa è almeno una soluzione rapida.

Altri suggerimenti

Sembra essere abilitato per impostazione predefinita. Ho appena provato un rapido test con 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

Quando clicco sul link per #my_method e mi passa il mouse sopra la descrizione del metodo, vedo il "Fare clic per scegliere origine" collegamento e funziona quando lo scatto.

Avrete bisogno del Javascript abilitato nel tuo browser per fare questo lavoro.

Sto avendo lo stesso problema con il mio codice Rails3. La sua piuttosto generica e non mi ricordo di aver giocato con la messa a punto RDoc, ma il mio click to toggle source non funziona neanche. So che JS sia acceso e loro non sono stati eventuali errori quando corro rake doc:app quindi sono abbastanza sicuro che cosa sta succedendo.

L'unica cosa che posso pensare è che sto correndo di Ruby 1.9.2 / Rails 3.0.0 sotto RVM. Questo fa la differenza?

UPDATE: Ho notato che il suo tentativo di caricare i file Javascript inesistenti da una directory js. È RDoc dovrebbe inserire i file JS o si fa a farlo manualmente?

Questo è un problema in un vecchie versioni di rdoc che stanno lavorando insieme con rvm. Ho avuto lo stesso problema con la versione 2.5.8. Il percorso della cartella templates contiene .rvm, in modo che le immagini e JS directory non vengono copiati nella documentazione generata. Come correzione, è possibile modificare questa riga di codice in lib / rdoc file / generatore / darkfish.rb 

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

a 

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

Grazie a Jeremy Bopp (per scoprire la fonte di questo problema - http://rubyforge.org/tracker/index.php?func=detail&aid=28482&group_id=627&atid=2472 ) e Gordon Thiesfeld (per dare soluzione - http://rubyforge.org/tracker/?func=detail&atid=2472&aid=26923&group_id=627 ) da Rubyforge.com

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top