RDoc: Algumas maneiras alternativas de consultar documentação

Uma coisa legal na linguagem Ruby é que sempre há muitos jeitos de fazer as coisas. O mesmo vale para a leitura da documentação das gems que você tem instalado na sua máquina. Aqui estão várias maneiras de visualizar a documentação RDoc das suas gems ao invés de rodar o comando "gem server".

Gembox

Gembox (fonte) é uma aplicação web baseado em Sinatra criado pelo Aaron Quint para navegar nas suas RDocs. Uma vez instalada, a Gembox permite que você navegue rapidamente através das suas gems, assim como os arquivos incluídos nelas e as gem specs.

Rodando "Gembox" na sua linha de comando, irá iniciar uma aplicação Sinatra que irá dar a você algumas informações básicas sobre suas gems, incluindo a documentação RDocs para cada gem. Aaron tem esperanças de adicionar algumas opções avançadas no futuro. Se você gostaria de navegar na documentação da sua gem em um formato mais amigável e conseguir mais informações das suas gems, que a interface padrão lhe oferece, experimente a Gembox.

Sinatra Rubygems

Sinatra-Rubygems é um projeto de Jesse Newland. Parecido com a Gembox, também é uma aplicação web baseada em Sinatra. No entanto a diferença é que, comparado com a Gembox que foi projetada para rodar da linha de comando, o Sinatra-Rubygems pode rodar em um servidor que suporte Passenger. Usando o PassengerPane você pode ter sua documentação RDocs rodando localmente no seu próprio webserver.

Embora seja preciso um pouco mais para se colocar o  Sinatra-Rubygems rodando (mas não muito!), isto é muito útil para ter suas RDocs rodando localmente.

Bdoc

Se qualquer uma dessas opções parece muito trabalho e se você quer suas RDocs de uma maneira fácil e simples, dê uma olhada no projeto Bdoc de Rich Manalang. Uma vez que rodamos na linha de comando, o Bdoc junta tudo em uma agradável página web com um pequeno IFRAME que permite que você navegue através das RDocs. Você pode rapidamente trocar entre diferentes gems e não existe a necessidade de rodar um servidor para mostrar suas RDocs.

Bdoc pode não ser tão chique como as outras aplicações baseadas em  Sinatra que citei, mas é uma idéia simples que não precisa de nenhum servidor para rodar. Se é documentação rápida e fácil  o que você procura, então o Bdoc pode ter sido feito para você.

Um novo tema um pouco mais chique ?

Mislav Marohnic, autor do excelente plugin will_paginate, tem um ótimo tema para RDoc chamado Hanna. Com seus familiares três painéis a esquerda para navegação, e um campo para procurar métodos feito em puro ajax, essa tema faz suas RDocs ficarem atualizadas.

Postado originalmente por Matthew Lang - Matthew Lang é um desenvolvedor de sistemas ERP com um entusiasmo crescente na programação Ruby e Rails.

Este artigo foi publicado originalmente em inglês em 02 de June de 2009 às 21:14 na categoria Diversos. Você pode deixar um comentário ou um trackback do seu próprio site.