Obtenga e instale una nueva plantilla RDOC

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

Pregunta

Estoy usando Ruby on Rails 3.0.7 y me gustaría instalar y usar una nueva plantilla RDOC (en lugar del valor predeterminado) para documentar mi aplicación.

Me gustaría elegir uno de los siguientes:

Asi que,

  1. ¿Dónde puedo obtener una de las plantillas anteriores?
  2. ¿Cómo puedo instalar eso?
  3. ¿Qué código debo poner en un .rake ¿Archivo para generar la documentación con la plantilla elegida?

En pocas palabras, soy un novato en este asunto.

En este momento en mi Gemfile he declarado lo siguiente:

gem "rdoc", "~> 3.6.1"

y corre el bundle install dominio.

Actualización I por @dmarkow

Instalé el Horo gema e insertó el siguiente código en mi .rake expediente

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

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

Si ejecuto el comando rdoc -f horo --main README.rdoc *.rdoc lib ext Entiendo esto:

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 ejecuto el comando rake doc:app Entiendo esto:

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)

Actualización II por @dmarkow

Quité el doc directorio:

Si ejecuto el comando rdoc -f horo --main README.rdoc *.rdoc lib ext Entiendo esto:

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

En el directorio de documentación crea un created.rid expediente.

Si ejecuto el comando rake doc:app Obtengo lo mismo que en la siguiente actualización.

¿Lo que tengo que hacer? Todavía tengo que guardar el gem "rdoc", "~> 3.6.1" ¿En mi Gemfile?

¿Fue útil?

Solución

El que se usa en http://api.rubyonrails.org es la plantilla "Horo". Puede encontrarlo aquí, junto con instrucciones para usarlo (está instalado a través de una gema):

https://github.com/tenderlove/horo

Otros consejos

Prefiero Hanna, resp Hanna-Nouveau. Hanna estaba bien, pero se basa en una vieja versión RDOC. Base de Hanna-Nouveau en el Hanna original, pero funciona con RDOC 3 (probado con RDOC 3.12).

Eso parece Example for Hanna

Puede ver otro ejemplo en http://gems.rubypla.net/todonotes/0.1.0/

Los detalles se pueden encontrar en https://github.com/rdoc/hanna-nouveau. los Readme Contiene información sobre instalación y uso.

Actualización 2014

Hanna-Nouveau no funciona con RDOC 4.

Lo que puede hacer: instale una vieja versión RDOC (uso 3.12). No hay necesidad de desinstalar la versión más real. Puede llamar a la versión RDOC dependiendo:

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

Con _3.12_ La versión RDOC 3.12 está cargada. Con -f hanna Hanna-Nouveau se usa.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top