Gerar documentacao pro RUby ??

58 views
Skip to first unread message

Vinicíus Luiz

unread,
Dec 18, 2009, 9:22:13 AM12/18/09
to rails-br
Ola pessoal,
a documentacao do ruby eh uma mao na roda

http://corelib.rubyonrails.org/

entretanto, algumas vezes preciso usa la mas estou offline, por isso,
queria saber se tem alguma forma de gerar essa documentacao ???

Rafael Rosa

unread,
Dec 18, 2009, 9:41:57 AM12/18/09
to rail...@googlegroups.com
Salve,

No diretório de um projeto Ruby, digite os seguintes comandos:

sudo gem install RedCloth
rake rails:freeze:gems
rake doc:rails
rake doc:guides

Isso vai gerar toda a documentação do código no diretório doc/api e também o Rails Guides. Acabei de fazer um teste na minha máquina e ele está com problemas para gerar o Rails Guides, vou verificar e ver se é um problema de ambiente ou não.

Vinicius Luiz

unread,
Dec 18, 2009, 9:50:32 AM12/18/09
to rail...@googlegroups.com
aqui ele comeca a gerar mas entao da erro

rake aborted!
Missing template credits.erb in view path config/../vendor/rails/railties/lib/../guides/rails_guides/../source

(See full trace by running task with --trace)

so que isso eh documentacao do Rails correto, ela incorpora a do Ruby tambem ?? 

to precisando de uma tipo a que passei no link so para ruby



att,

p.s.: se resolver o problemas da geracao dos guides, avisae :)

Vinicius Luiz
Skype/Yahoo: vinicius.luiz
MSN: vinic...@hotmail.com
Gtalk: mcp.vi...@gmail.com
Twitter: http://twitter.com/vinicius_luiz
Blog: http://viniciusluizz.wordpress.com

----------------------------------------------

           Analista Desenvolvedor - TI                
CETAM Ltda. - Centro de Tecnologia da Amazônia

when there is no place in hell, the dead walked the earth!


2009/12/18 Rafael Rosa <rafael...@gmail.com>

--

Você está recebendo esta mensagem porque se inscreveu no grupo "rails-br" dos Grupos do Google.
Para postar neste grupo, envie um e-mail para rail...@googlegroups.com.
Para cancelar a inscrição nesse grupo, envie um e-mail para rails-br+u...@googlegroups.com.
Para obter mais opções, visite esse grupo em http://groups.google.com/group/rails-br?hl=pt-BR.

Rafael Rosa

unread,
Dec 18, 2009, 9:56:32 AM12/18/09
to rail...@googlegroups.com
Salve,

Foi mal, você falou Ruby eu entendi Rails :( Para baixar a documentação do ruby visite:


Estou vendo o lance da documentação do Rails, quero deixar isso arrumado.

Vinicius Luiz

unread,
Dec 18, 2009, 10:01:33 AM12/18/09
to rail...@googlegroups.com
rake doc:rails # aqui uso e funciona direitinho mas 0
rake doc:guides # da erro ao tentar gerar..

quando voce arrumar o guides,
coloca o motivo do problema aqui pra gente blz..

att,


Vinicius Luiz
Skype/Yahoo: vinicius.luiz
MSN: vinic...@hotmail.com
Gtalk: mcp.vi...@gmail.com
Twitter: http://twitter.com/vinicius_luiz
Blog: http://viniciusluizz.wordpress.com

----------------------------------------------

           Analista Desenvolvedor - TI                
CETAM Ltda. - Centro de Tecnologia da Amazônia

when there is no place in hell, the dead walked the earth!


2009/12/18 Rafael Rosa <rafael...@gmail.com>
Salve,

--

Rafael Rosa

unread,
Dec 18, 2009, 11:18:49 AM12/18/09
to rail...@googlegroups.com
Salve,

Para corrigir a geração do Rails Guides é preciso alterar uma linha no código do Rails. Abra o arquivo:

/usr/local/lib/ruby/gems/1.8/gems/rails-2.3.5/guides/rails_guides/generator.rb

Ou ajuste a path do Rails para sua versão, e troque a linha 51 pela seguinte linha:

result = view.render(:layout => 'layout', :file => guide)

A diferença é que o file deve receber a variável guide e n


2009/12/18 Vinicius Luiz <mcp.vi...@gmail.com>



--

Rafael Rosa

unread,
Dec 18, 2009, 11:21:13 AM12/18/09
to rail...@googlegroups.com
Meu último e-mail foi truncado.

.....
A diferença é que o render deve receber a variável file ao invés de name, que tem o nome completo do arquivo. Essa correção já foi feita e deve ser incluída no Rails 3.

Rafael Rosa

unread,
Dec 18, 2009, 11:39:04 AM12/18/09
to rail...@googlegroups.com
Salve,

Acabei de lembrar que é necessário refazer o package da gem para que ela funcione com o patch, mas na minha máquina está dando problema, então recomendo fazer o seguinte: primeiro façam o rake rails:freeze:gem e apliquem a correção no Rails vendorizado. Isso evita problemas e a geração do help não é algo tão frequente mesmo. Na próxima versão tudo irá funcionar 100%.

Pedro Fernandes Steimbruch

unread,
Dec 18, 2009, 2:09:34 PM12/18/09
to rail...@googlegroups.com
Já que tão falando de documentação offline.

# gem server

Irá abrir um servidor na porta 8808 com a documentação de todas a gems instaladas, que por sua vez tiveram a documentação instalada com sucesso.

Talvez vocês já conheçam. ;P

Pedro Fernandes Steimbruch

unread,
Dec 18, 2009, 2:10:01 PM12/18/09
to rail...@googlegroups.com
Não precisa ser root, logo:

$ gem server

;P~

Glauber Alex Dias Prado

unread,
Dec 20, 2009, 8:14:17 PM12/20/09
to rail...@googlegroups.com

> --
>
> Você está recebendo esta mensagem porque se inscreveu no grupo "rails-br" dos Grupos do Google.
> Para postar neste grupo, envie um e-mail para rail...@googlegroups.com.
> Para cancelar a inscrição nesse grupo, envie um e-mail para rails-br+u...@googlegroups.com.
> Para obter mais opções, visite esse grupo em http://groups.google.com/group/rails-br?hl=pt-BR.

Pra gerar a documentação do ruby vc usa o comando rdoc no diretório com
a fonte do ruby, ele vai gerar e instalar pra você no diretório doc/,
esqueci como eu fiz aqui pra gerar a documentação e instalar direto no
sistema. O que vc pode fazer é rdoc --help e ler os parâmetros.Ele
também gera a documentação pro ri que serve pra consultar interativamente.

Vinicius Luiz

unread,
Dec 28, 2009, 6:24:51 AM12/28/09
to rail...@googlegroups.com
Poh, o guides funcionou direitinho mas vou fazer so uma observacao.. uso ubuntu e o path da alteracao foi

/usr/lib/ruby/gems/1.8/gems/rails-2.3.5/guides/rails_guides

sem o diretorio local. Fora isso, abracos!!

att,

Vinicius Luiz
Skype/Yahoo: vinicius.luiz
MSN: vinic...@hotmail.com
Gtalk: mcp.vi...@gmail.com
Twitter: http://twitter.com/vinicius_luiz
Blog: http://viniciusluizz.wordpress.com

----------------------------------------------

           Analista Desenvolvedor - TI                
CETAM Ltda. - Centro de Tecnologia da Amazônia

when there is no place in hell, the dead walked the earth!


2009/12/20 Glauber Alex Dias Prado <sma...@gmail.com>
Reply all
Reply to author
Forward
0 new messages