How to force RDoc not to parse a file?

ruby-talk
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.

···

--
Iñaki Baz Castillo
<ibc@aliax.net>

2

Iñaki Baz Castillo 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.

···

--
Posted via http://www.ruby-forum.com/\.

3

Tim Hunter wrote:

Iñaki Baz Castillo 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.

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

···

--
       vjoel : Joel VanderWerf : path berkeley edu : 510 665 3407

4

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.

···

--
Posted via http://www.ruby-forum.com/\.

5

Yes, that is exactly what I want.

···

2009/7/28 Joel VanderWerf <vjoel@path.berkeley.edu>:

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.

--
Iñaki Baz Castillo
<ibc@aliax.net>

6

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

···

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

2009/7/28 Joel VanderWerf <vjoel@path.berkeley.edu>:

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.

7

Done :slight_smile:

···

El Martes, 28 de Julio de 2009, Ryan Davis escribió:

On Jul 28, 2009, at 10:11 , Iñaki Baz Castillo wrote:
> 2009/7/28 Joel VanderWerf <vjoel@path.berkeley.edu>:
>>> 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.

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

--
Iñaki Baz Castillo <ibc@aliax.net>