How to force RDoc not to parse a file?

Ruby
1

Hi, I want to include a text file (LICENSE.txt) in the RDoc
documentation. However, I don’t want RDoc to parse it, instead, I want
it to be displayed as text format.
Is it possible with some commandline option of rdoc? I’ve not found
it…

Thanks.

2

Iñaki Baz C. wrote:

Hi, I want to include a text file (LICENSE.txt) in the RDoc
documentation. However, I don’t want RDoc to parse it, instead, I want
it to be displayed as text format.
Is it possible with some commandline option of rdoc? I’ve not found
it…

Thanks.

Did you try rdoc --help?

   --exclude, -x pattern
                        do not process files or directories matching
                        pattern. Files given explicitly on the

command
line will never be excluded.

3

Tim H. wrote:

   --exclude, -x pattern
                        do not process files or directories matching
                        pattern. Files given explicitly on the

command
line will never be excluded.

Maybe he wanted to suppress markup but still include the file in the
rdoc output and index listing. That seems reasonable for LICENSE.txt.

4

2009/7/28 Joel VanderWerf [email protected]:

Did you try rdoc --help?

   --exclude, -x pattern
              do not process files or directories matching
              pattern. Files given explicitly on the command
              line will never be excluded.

Maybe he wanted to suppress markup but still include the file in the rdoc
output and index listing. That seems reasonable for LICENSE.txt.

Yes, that is exactly what I want.

5

On Jul 28, 2009, at 10:11 , Iñaki Baz C. wrote:

Maybe he wanted to suppress markup but still include the file in
the rdoc
output and index listing. That seems reasonable for LICENSE.txt.

Yes, that is exactly what I want.

I don’t think you can do that. File a feature request on the rdoc
project on rubyforge.

6

Joel VanderWerf wrote:

Maybe he wanted to suppress markup but still include the file in the
rdoc output and index listing. That seems reasonable for LICENSE.txt.

You’re right. I didn’t read his post carefully enough.

7

El Martes, 28 de Julio de 2009, Ryan D.
escribió:> >>

Maybe he wanted to suppress markup but still include the file in
the rdoc
output and index listing. That seems reasonable for LICENSE.txt.

Yes, that is exactly what I want.

I don’t think you can do that. File a feature request on the rdoc
project on rubyforge.

Done :slight_smile: