Este é um daqueles posts essenciais para quem quer trabalhar de qualquer lugar, sem ter que se preocupar se vai ter acesso a consciência coletiva (Google/Stack Overflow), afinal sabemos que 3G e Wifi só funcionam bem na loja da operadora e em casa, respectivamente.

O primeiro passo é garantir que todas as nossas gems instaladas passaram pelo processo de geração da documentação. Isso é muito importante, por que, por padrão, o Bundler não executa a geração do RDoc, para garantir uma melhor performance:

gem rdoc [--all|gem_name]

O processo vai demorar consideravelmente de acordo com a quantidade de Gems que você possui.

Aqui entra duas opções, você pode suar somente os comandos que já possui (isto, é usar o “gem” para hospedar as próprias documentações), ou usar algo melhor como o YARD.

O YARD é a mesma ferramenta que é responsável pela geração das documentações no RubyDoc.info.

A instalação é via Rubygems:

gem install yard

Para acessar a documentação, basta rodar o servidor embutido:

yard server --gems

Resultado final acessando http://0.0.0.0:8808: