Forum: Ruby Does Darkfish-Rdoc work properly?

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
0f1f17ba297242e9d3c86d4cc0a6ea85?d=identicon&s=25 Iñaki Baz Castillo (Guest)
on 2009-03-03 00:09
(Received via mailing list)
Hi, I've installed "rdoc" via gem and got surprised since the downloades
version in Darkfish-Rdoc:
  http://deveiate.org/projects/Darkfish-Rdoc/

I'm not sure if Darkfish-Rdoc is the continuation of RDoc or a
fork/version (I
expected it was a version due to the project description).

The version installed is rdoc 2.4.1.

When I run "rdoc" in a simple directory with just 3 files, I get a big
ammount
of doc directories (obviously something is wrong) like:

  my_project/doc/doc/doc/doc/doc/doc/doc..

containing files with name:

  MyClass_html_html_html_html_html_html.html

and so on.

Could somebody clarify me on it?

Thanks a lot.
58479f76374a3ba3c69b9804163f39f4?d=identicon&s=25 Eric Hodel (Guest)
on 2009-03-03 00:56
(Received via mailing list)
On Mar 2, 2009, at 15:04, Iñaki Baz Castillo wrote:

> Hi, I've installed "rdoc" via gem and got surprised since the
> downloades
> version in Darkfish-Rdoc:
>  http://deveiate.org/projects/Darkfish-Rdoc/
>
> I'm not sure if Darkfish-Rdoc is the continuation of RDoc or a fork/
> version (I
> expected it was a version due to the project description).

It is a generator.

> The version installed is rdoc 2.4.1.

This version contains the latest Darkfish as of today.

> and so on.
>
> Could somebody clarify me on it?

Don't run rdoc against it's output directory.

If your project uses hoe, `rake docs` will do the right thing.
0f1f17ba297242e9d3c86d4cc0a6ea85?d=identicon&s=25 Iñaki Baz Castillo (Guest)
on 2009-03-03 01:02
(Received via mailing list)
El Martes, 3 de Marzo de 2009, Eric Hodel
escribió:
> Don't run rdoc against it's output directory.

True, thanks. But I wonder why using RDoc V1.0.1 - 20041108 I can run
"rdoc"
command from the sources directory (so it generates "doc" directory).
Anyway
I understand that I shouldn't do it.

Thanks a lot.
5a837592409354297424994e8d62f722?d=identicon&s=25 Ryan Davis (Guest)
on 2009-03-03 04:06
(Received via mailing list)
On Mar 2, 2009, at 16:00 , Iñaki Baz Castillo wrote:

> El Martes, 3 de Marzo de 2009, Eric Hodel escribió:
>
>> Don't run rdoc against it's output directory.
>
> True, thanks. But I wonder why using RDoc V1.0.1 - 20041108 I can
> run "rdoc"
> command from the sources directory (so it generates "doc"
> directory). Anyway
> I understand that I shouldn't do it.

most ppl generate rdoc via their rakefile and that includes a "clean"
dependency that is met before the rdoc generates. If you use hoe you
get this for free.
This topic is locked and can not be replied to.