Obtenez et installez un nouveau modèle RDoc

Question

J'utilise Ruby on Rails 3.0.7 et je souhaite installer et utiliser un nouveau modèle RDoc (au lieu du modèle par défaut) afin de documenter mon application.

Je souhaite choisir l'une des options suivantes:

• http://api.rubyonrails.org/
• http://www.ruby-doc.org/core/
• ... autres que vous conseillez

Donc,

1. Où puis-je obtenir l'un des modèles ci-dessus?
2. Comment puis-je l'installer?
3. Quel code dois-je mettre dans un fichier .rake pour générer la documentation avec le modèle choisi?

En quelques mots, je suis un novice dans ce domaine.

---

À ce stade, dans mon Gemfile, j'ai déclaré ce qui suit:

gem "rdoc", "~> 3.6.1"

et exécutez la commande bundle install.

---

MISE À JOUR I pour @dmarkow

J'ai installé la gemme horo et inséré le code suivant dans un fichier my .rake

  RDoc::Task.new do |rdoc|
    rdoc.title    = "My Awesome docs"
    rdoc.rdoc_dir = 'doc'

    rdoc.options << '-f' << 'horo'
    rdoc.options << '--main' << 'README'
  end

Si j'exécute la commande rdoc -f horo --main README.rdoc *.rdoc lib ext, j'obtiens ceci:

file '*.rdoc' not found
file 'ext' not found
uh-oh! RDoc had a problem:

Directory doc already exists, but it looks like it isn't an RDoc directory.

Because RDoc doesn't want to risk destroying any of your existing files,
you'll need to specify a different output directory name (using the --op <dir>
option)

Si j'exécute la commande rake doc:app, j'obtiens ceci:

WARNING: Deprecated reference to top-level constant 'Task' found at: <my_application_projectfolder>/Rakefile:7:in `<top (required)>'
    Use --classic-namespace on rake command
    or 'require "rake/classic_namespace"' in Rakefile
rake aborted!
wrong number of arguments (0 for 2)

---

MISE À JOUR II pour @dmarkow

J'ai supprimé le répertoire doc:

Si j'exécute la commande rdoc -f horo --main README.rdoc *.rdoc lib ext, j'obtiens ceci:

file '*.rdoc' not found
file 'ext' not found

No newer files.

Files:      0

Classes:    0 (0 undocumented)
Modules:    0 (0 undocumented)
Constants:  0 (0 undocumented)
Attributes: 0 (0 undocumented)
Methods:    0 (0 undocumented)

Total:      0 (0 undocumented)
  0.00% documented

Dans le répertoire de documentation, il crée un fichier created.rid.

Si j'exécute la commande rake doc:app, j'obtiens la même chose que dans la mise à jour suivante.

Que dois-je faire? Je dois encore conserver le gem "rdoc", "~> 3.6.1" dans mon Gemfile?

Answer 1

Celui utilisé sur http://api.rubyonrails.org est le modèle "Horo".Vous pouvez le trouver ici, ainsi que les instructions pour l'utiliser (il est installé via une gemme):

https://github.com/tenderlove/horo

Answer 2

Je préfère Hanna, resp Hanna-nouveau. Hanna allait bien, mais il est basé sur une ancienne version rdoc. Base Hanna-nouveau sur Hanna d'origine, mais elle fonctionne avec rdoc 3 (testé avec rdoc 3.12).

Cela ressemble à

Vous pouvez voir un autre exemple dans http://gems.rubypla.net/todonotes/ 0.1.0 /

Des détails peuvent être trouvés sur https://github.com/rdoc/hanna-nouveau. Le Readme contient des informations sur l'installation et l'utilisation.

---

Mise à jour 2014

Hanna-nouveau ne fonctionne pas avec rdoc 4.

Ce que vous pouvez faire: Installez une ancienne version de rdoc (j'utilise la version 3.12). Il n'est pas nécessaire de désinstaller la version la plus actuelle. Vous pouvez appeler la version rdoc selon:

rdoc _3.12_ -f hanna [...more options...]

Avec _3.12_, la rdoc-version 3.12 est chargée. Avec -f hanna, hanna-nouveau est utilisé.