Ottieni e installa un nuovo modello RDOC

Question

Sto usando Ruby on Rails 3.0.7 e vorrei installare e utilizzare un nuovo modello RDOC (anziché il valore predefinito) per documentare la mia applicazione.

Vorrei scegliere uno dei seguenti:

• http://api.rubyonrails.org/
• http://www.ruby-doc.org/core/
• ... altri che consigli

Così,

1. Dove posso ottenere uno dei modelli di cui sopra?
2. Come posso installarlo?
3. Che codice dovrei inserire in un file .rake File per generare la documentazione con il modello scelto?

In poche parole, sono un principiante in queste questioni.

---

In questo momento nel mio gemfile ho dichiarato quanto segue:

gem "rdoc", "~> 3.6.1"

e eseguire il bundle install comando.

---

AGGIORNAMENTO I. per @dmarkow

Ho installato il Horo gemma e inserito il seguente codice in un mio .rake file

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

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

Se eseguo il comando rdoc -f horo --main README.rdoc *.rdoc lib ext Capisco questo:

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)

Se eseguo il comando rake doc:app Capisco questo:

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)

---

Aggiornamento II per @dmarkow

Ho rimosso il doc Directory:

Se eseguo il comando rdoc -f horo --main README.rdoc *.rdoc lib ext Capisco questo:

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

Nella directory della documentazione crea a created.rid file.

Se eseguo il comando rake doc:app Ottengo lo stesso del seguente aggiornamento.

Cosa devo fare? Devo ancora mantenere il gem "rdoc", "~> 3.6.1" nel mio gemfile?

Answer 1

Quello usato a http://api.rubyonrails.org è il modello "Horo". Puoi trovarlo qui, insieme alle istruzioni per usarlo (è installato tramite una gemma):

https://github.com/tenderlove/horo

Answer 2

Preferisco Hanna, resp Hanna-Nouveau. Hanna stava bene, ma si basa su una vecchia versione RDOC. Base Hanna-Nouveau sulla Hanna originale, ma funziona con RDOC 3 (testato con RDOC 3.12).

Esso sembra

Potresti vedere un altro esempio in http://gems.rubypla.net/todonotes/0.1.0/

I dettagli possono essere trovati a https://github.com/rdoc/hanna-nouveau. Il Readme Contiene informazioni sull'installazione e l'utilizzo.

---

Aggiornamento 2014

Hanna-Nouveau non funziona con RDOC 4.

Cosa puoi fare: installare una vecchia versione RDOC (uso 3.12). Non è necessario disinstallare la versione più reale. Puoi chiamare la versione RDOC a seconda:

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

Insieme a _3.12_ La versione RDOC 3.12 viene caricata. Insieme a -f hanna Viene utilizzato Hanna-Nouveau.