¿Cómo crear documentation API para proyectos en GitHub?

Tengo varios proyectos de ruby ​​y Rails alojados en GitHub.

Me pregunto cómo podría crear documentation API para estos automáticamente?

Ejemplos:

http://rake.rubyforge.org/

http://rspec.rubyforge.org/rspec/1.3.0/

¿Hay tutoriales para crear estos documentos API en Ruby?

Ambos ejemplos se generan utilizando RDoc . El primero es la plantilla RDoc estándar, el segundo se genera con Hanna .

Puede generar fácilmente la documentation utilizando la herramienta de command-line de RDoc o creando una tarea de Rake. Por ejemplo, esta documentation se genera con la siguiente tarea

begin require "hanna/rdoctask" rescue LoadError require "rake/rdoctask" end # Generate documentation Rake::RDocTask.new do |rd| rd.main = "README.rdoc" rd.rdoc_files.include("*.rdoc", "lib/**/*.rb") rd.rdoc_dir = "rdoc" end 

Vea el Rakefile para más detalles.

GitHub proporciona webhooks por repository (es decir, puede habilitarlo para este o aquel repository, pero no estos otros dos aquí). Uno de los webhooks está vinculado a rdoc.info , que usa Yard para producir documentation variada. (El patio en sí es similar al rdoc. Si conoce rdoc, no tendrá ningún problema para recoger Yard). Ejemplo: documentos propios del patio .

En su repository, vaya a Configuración -> Webhooks y services -> Webhooks para agregar un webhook apropiado. (Hay documentation para webhooks en el sitio API de GitHub . También vea la nota en esta página para get información sobre cómo personalizar qué files se escanean en busca de documentation dentro de un repository).

http://rdoc.info puede ayudarlo a crear documentation directamente desde su repository github, vaya a http://rdoc.info/projects/new para agregar su proyecto.