Pregunta

Estoy tratando de orinar mi documentación RDOC, usando la versión 3.5.3. No soy fanático del tema incorporado de Darkfish, así que intenté encontrar una manera de reemplazarlo con el utilizado por la documentación oficial de la API de Rails en http://api.rubyonrails.org/, pero no tuve suerte de encontrarlo en ninguna forma fácilmente disponible. He buscado en todo Github, entre otras cosas.

Lo que he encontrado hasta ahora es

que podría estar ligeramente desactualizado, y es tenedor

Ambos son agradables, pero no exactamente lo que quiero. Entonces, antes de comenzar a jugar con esas plantillas, ¿alguien sabe si la plantilla utilizada por los Docios API Rails está disponible como una joya en alguna parte?

¡Gracias!

¿Fue útil?

Solución

Esto se parece. Ignora las instrucciones que dicen hacer un gem install horo --pre - Eso en realidad te dará una versión beta más antigua. Solo haz gem install horo y obtendrás la versión actual 1.0.3 (Editar: Envié una solicitud de extracción para actualizar las instrucciones, que ya han sido aceptadas).

https://github.com/tenderlove/horo

Por cierto, encontré esto mirando el Código fuente de Rails y ver el Rakefile Para ver las opciones RDOC. Específicamente, la línea 67 muestra rdoc.options << '-f' << 'horo'.

Otros consejos

Sé que esto es muy tarde, pero parece que la nueva versión de Rails usa algo llamado SDOC, que mejora la salida con JavaScript Búsqueda, y es un poco más limpio IMO. Hacer un simple "SDOC de instalación de gemas" obtendrá lo que necesita, luego simplemente use rdoc.options << '-f' << 'sdoc'.

El proyecto GitHub parece estar en https://github.com/voloko/sdoc/

Por cierto, ¡gracias por la pregunta! Sin la respuesta inicial publicada, ¡nunca había encontrado dónde mirar, y me quedé atrapado con ese horrible tema de pez oscuro para mis propios proyectos!

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