Como ativar o botão “Clique para alternar a fonte” no Ruby RDOC?

StackOverflow https://stackoverflow.com/questions/3800704

  •  25-09-2019
  •  | 
  •  

Pergunta

Ao usar o gerador RDOC Darkfish para gerar documentação RDOC, ao lado dos métodos, há um Click to toggle source botão ao lado de cada método. Não está funcionando para mim quando eu gero minha documentação, então como você faz com que esse recurso funcione, você precisa adicionar uma palavra -chave à sua fonte RDOC ou algo assim?alt text

Foi útil?

Solução

Eu tive os mesmos problemas e encontrei os arquivos ausentes em http://rack.rubyforge.org/doc/js . Eu os copiei manualmente em um diretor Doc/App/JS e agora Clique para alternar a fonte funciona. Isso é pelo menos uma correção rápida.

Outras dicas

Parece estar ativado por padrão. Acabei de experimentar um teste rápido com RDOC v2.5.11:-

$ mkdir temp
$ cd temp
$ cat temp.rb

class MyClass
  def my_method; end
end

$ rdoc
Parsing sources...
100% [ 1/ 1]  temp.rb                                                           

Generating Darkfish...

Files:         1
Classes:       1 (    1 undocumented)
Constants:     0 (    0 undocumented)
Modules:       0 (    0 undocumented)
Methods:       1 (    1 undocumented)
  0.00% documented

Elapsed: 0.1s
$ open doc/index.html

Quando eu clico no link para #my_method E passe o mouse sobre a descrição do método, vejo o link "Clique para alternar a fonte" e ele funciona quando clico nele.

Você precisará de JavaScript ativado no seu navegador para fazer isso funcionar.

Estou tendo o mesmo problema com meu código Rails3. É bastante genérico e não me lembro de brincar com a configuração do RDOC, mas meu click to toggle source Também não funciona. Eu sei que o JS está ligado e eles não foram erros quando eu corro rake doc:app Portanto, não tenho certeza de que o que está acontecendo.

A única coisa que consigo pensar é que estou executando o Ruby 1.9.2 / Rails 3.0.0 sob o RVM. Isso faz alguma diferença?

ATUALIZAR: Percebi que está tentando carregar arquivos JavaScript inexistentes de um js diretório. O RDOC deveria inserir os arquivos JS ou você deve fazê -lo manualmente?

Isso é um problema em versões antigas do RDOC que estão trabalhando em conjunto com o RVM. Eu tive o mesmo problema com a versão 2.5.8. O caminho para o diretório de modelos contém .rvm, para que as imagens e os diretórios JS não sejam copiados para a documentação gerada. Como correção, você pode alterar esta linha de código no arquivo lib/rdoc/gerador/escura

next if path =~ /#{File::SEPARATOR}\./

para

next if path =~ /#{@template_dir}.*#{File::SEPARATOR}\./

Graças a Jeremy Bopp (para descobrir a fonte desta edição - http://rubyforge.org/tracker/index.php?func=detail&aid=28482&group_id=627&atid=2472) e Gordon Thiesfeld (para dar solução - http://rubyforge.org/tracker/?func=detail&atid=2472&aid=26923&group_id=627) de rubyforge.com

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top