rdoc question

[Tim Pease]

I have developed my own syntax for some validation scripts here at
work. I would like to include some examples of these validation
scripts in the RDoc documentation for the package. Is there a way to
simply include these example files "as is" without RDoc trying to
format the files?

directory structure:

ext/
bin/
lib/
test/
examples/example1.pdv
examples/example2.pdv
...

I can include example1.pdv et. al, but RDoc is stringing together
consecutive lines into one big paragraph and other things like that.
Without changing my example files, how do I tell RDoc to just put
these things inside one big code block?

TwP

 

[Eric Hodel]

I have developed my own syntax for some validation scripts here at
work. I would like to include some examples of these validation
scripts in the RDoc documentation for the package. Is there a way to
simply include these example files "as is" without RDoc trying to
format the files?

directory structure:

ext/
bin/
lib/
test/
examples/example1.pdv
examples/example2.pdv
...

I can include example1.pdv et. al, but RDoc is stringing together
consecutive lines into one big paragraph and other things like that.
Without changing my example files, how do I tell RDoc to just put
these things inside one big code block?

I don't believe you can. :include: expects RDoc formatted text.

 

[Tim Pease]

I don't believe you can. :include: expects RDoc formatted text.

Eric, thanks for the reply. I was hoping I was missing something in
the documentation, but alas, it is not to be.

TwP