Publique sua documentação Ruby no Github com o Rdoc.info

Este post foi originalmente publicado por Matt Sears da Littlelines.

Rdoc.info é um simples web service que usa YARD (uma ferramenta de geração de documentação para Rubistas) para gerar a documentação das bibliotecas Ruby hospedadas no Github. Se você não conhece YARD, ele permite que você adicione metadados na documentação Ruby, semelhante a outras linguagens como Java e Objective-C. Uma coisa coisa legal sobre o YARD é que ele é extensível e permite que você encaixe handlers e saídas customizadas.

Rdoc.info, anunciado em Abril, foi lançado com um projeto paralelo pelo Nick Plante. Nick conseguiu fazer com que os post-receive-hooks do Github gerassem e hospedassem automaticamente documentação Ruby toda vez que um projeto no Github receber um commit. Como um trabalho solitário, o Rdoc.info é uma ideia simples e esperta. Mas espere, porque tem mais!

Nick se juntou com Jeff Rafter e deu um passo a mais no projeto fazendo a documentação ficar disponível no próprio Github. Jeff compilou Github Has An Apps Platform, um artigo muito bom onde eles explicam como fizeram isso possível. O resultado final, um agradável navegador de RDoc hospedado em docs.github.com, permitindo que você visualize de maneira rápida métodos, namespaces e todo o código fonte usando o Github.

Ainda jovem, esse projeto promete muito. Muitas bibliotecas Ruby populares já adicionaram sua documentação no Github, como Rack, Rspec e Sinatra para citar alguns nomes.

Para fazer sua documentação ficar disponível no Github, leia as instruções disponíveis em docs.github.com.

Este artigo foi publicado originalmente em inglês em 29 de June de 2009 às 11:00 na categoria Diversos, Documentação, Ferramentas. Você pode deixar um comentário ou um trackback do seu próprio site.