Discussion:
Use of .document with RDoc
Barrie Stott
2010-07-02 13:38:04 UTC
Permalink
Suppose I've installed the rdoc (2.5.8) gem without creating any
documentation. It has a top level file, .document, that contains:

History.txt
README.txt
RI.txt
lib

I move to the directory .../gems/rdoc-2.5.8 and run the command:

rdoc --ri --op /tmp/doc

I expect to get all relevant ri documentation in /tmp/doc but I see
nothing corresponding to the .txt files mentioned in .document.

I would be grateful if someone could explain to me what I am doing
wrong and, even more importantly, what I should do to get the
documentation corresponding to the .txt files.

Barrie.
Roger Pack
2010-07-02 22:40:27 UTC
Permalink
if you have
dir1/
History.txt
README.txt


then your .document file should be in dir1, like
History.txt
README.txt
lib

then run it like
cd ..
rdoc dir1

or rdoc .

and something about those files should show up in the output.
Barrie Stott
2010-07-03 09:02:32 UTC
Permalink
Post by Roger Pack
if you have
dir1/
History.txt
README.txt
then your .document file should be in dir1, like
History.txt
README.txt
lib
then run it like
cd ..
rdoc dir1
or rdoc .
and something about those files should show up in the output.
I suspect that wanting stuff from non-ruby files available to ri was
stupid. If I had a dozen gems each with a README.txt, how would I tell
ri which one I wanted? I need rdoc output to see such information and
that is provided without problem.

I'm sorry for any trouble I have caused and am grateful for your reply
since it set me on the right lines.

Barrie.

Loading...