Comment générer de la documentation Ruby en utilisant un modèle différent?

Question

Je souhaite générer le modèle Ruby documentation avec hanna.

Comment faire cela? Où puis-je le télécharger s'il est disponible?

En utilisant

rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna

me donne docs avec des méthodes manquantes. Il semble que cela ne génère pas de méthodes écrites en C.

Answer 1

avère que vous avez juste besoin obtenir le Ruby source code, l'extraire, puis dans le répertoire source, exécutez quelque chose comme ceci:

rdoc -o <output path> --inline-source --line-numbers --format=html --template=hanna 

Answer 2

gem install Mislav-hanna

Ensuite, il suffit de suivre les étapes du readme:

http://github.com/mislav/hanna/blob/8eaeb062fae276b19eb86fa302e9ee446a06eef8/README.markdown

Answer 3

dans votre rubis si répertoire urce, exécutez

hanna des numéros de --line-source---inline --format = html

Answer 4

Si vous utilisez RVM, cela fonctionne:

$ gem install hanna 
$ cd ~/.rvm/src/ruby-1.8.6-p383 
$ hanna -o doc/api --inline-source --line-numbers --fmt=html 
$ open doc/api/index.html