Comment puis-je activer le bouton « Cliquez pour activer la source » dans Ruby RDoc?

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

  •  25-09-2019
  •  | 
  •  

Question

Lors de l'utilisation du générateur de RDoc Darkfish pour générer la documentation de RDoc, suivant des procédés il y a un bouton de Click to toggle source à côté de chaque méthode. Il ne fonctionne pas pour moi quand je produis ma documentation, comment obtenez-vous cette fonctionnalité au travail, avez-vous d'ajouter un mot clé dans votre source RDoc ou quelque chose? text alt

Était-ce utile?

La solution

J'ai eu les mêmes problèmes et trouvé les fichiers manquants http://rack.rubyforge.org/doc / js . Je les ai copiés manuellement dans un doc / app / js dir et maintenant Cliquer ici pour basculer la source fonctionne. Ceci est au moins une solution rapide.

Autres conseils

Il semble être activé par défaut. Je viens d'essayer un test rapide avec 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

Lorsque je clique sur le lien pour #my_method et je Survoler la description de la méthode, je vois le lien « cliquez pour activer la source » et il fonctionne quand je clique dessus.

Vous avez besoin de Javascript activé dans votre navigateur pour faire ce travail.

Je suis le même problème avec mon code Rails3. Son assez générique et je ne me souviens pas de jouer avec la configuration RDoc, mais mon click to toggle source ne fonctionne pas non plus. Je sais que JS est activé et leur ont pas eu d'erreur quand je lance rake doc:app donc je ne suis pas tout à fait sûr ce qui se passe.

La seule chose que je peux penser est que je suis en Ruby 1.9.2 / Rails 3.0.0 sous RVM. Est-ce que faire une différence?

Mise à jour: J'ai remarqué que son essayant de charger des fichiers Javascript non existants à partir d'un répertoire js. Est-RDoc censé insérer les fichiers JS ou êtes-vous censé le faire manuellement?

C'est un problème dans une ancienne version de rdoc qui travaillent ensemble avec RVM. J'ai eu même problème avec la version 2.5.8. Le chemin d'accès au répertoire des modèles contient .rvm, de sorte que les images et les répertoires js ne soit pas copié dans la documentation générée. Comme solution, vous pouvez modifier cette ligne de code dans lib / rdoc / générateur / fichier darkfish.rb 

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

à 

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

Merci à Jeremy (Bopp pour découvrir la source de cette question - http://rubyforge.org/tracker/index.php?func=detail&aid=28482&group_id=627&atid=2472 ) et Gordon Thiesfeld (pour une solution donnant - http://rubyforge.org/tracker/?func=detail&atid=2472&aid=26923&group_id=627 ) à partir Rubyforge.com

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top