wxruby development - Nov 2008 - About Textile documentation for wxRuby

Hi again,

Currently, the Textile documentation is not included in the source tarball.
I also noticed that the html_docs rake task requires that wxWidgets be
installed.

In order to make documentation activity a bit easier :
- what about adding the Textile documentation into the source tarball
? (this will avoid using subversion just for the documentation).
- can the requirements on wxWidgets be removed for the html_docs rake task ?

Cheers.

Chauk-Mean.

Hi Chauk Mean

thanks for your other documentation contributions.

Chauk-Mean P wrote:
> Currently, the Textile documentation is not included in the source tarball.
> I also noticed that the html_docs rake task requires that wxWidgets be
> installed.
>
> In order to make documentation activity a bit easier :
>   
I''m happy to look at anything that would help here...
> - what about adding the Textile documentation into the source tarball
> ? (this will avoid using subversion just for the documentation).
>   
I tested this out and it looks like adding the Textile sources to the 
source tarball would increase its size by about 600kb. I''m not sure
this
is justifiable on its own as the base tarball is only 1MB. But like 
wxWidgets, I guess we could offer a wxruby-src-full tarball with more 
stuff in it like textile sources and possibly generated docs.
> - can the requirements on wxWidgets be removed for the html_docs rake task
?
>   
Yes, only the textile_docs task depends on the wxWidgets sources being 
installed. And we never normally need to run this task, except to 
generate docs when new classes are added.

cheers
alex

Alex,

2008/11/10 Alex Fenton <alex at pressure.to>:
> Chauk-Mean P wrote:
>> - what about adding the Textile documentation into the source tarball
>> ? (this will avoid using subversion just for the documentation).
>
> I tested this out and it looks like adding the Textile sources to the
source
> tarball would increase its size by about 600kb. I''m not sure this
is
> justifiable on its own as the base tarball is only 1MB. But like wxWidgets,
> I guess we could offer a wxruby-src-full tarball with more stuff in it like
> textile sources
That''s fine.
> and possibly generated docs.
I don''t think that it is useful. Unlike the textile documentation, the
generated docs already has its own tarball.
>> - can the requirements on wxWidgets be removed for the html_docs rake
task ?
>
> Yes, only the textile_docs task depends on the wxWidgets sources being
> installed. And we never normally need to run this task, except to generate
> docs when new classes are added.
That''s great.

Cheers.

Chauk-Mean.

Hi Alex,

2008/11/10 Chauk-Mean P <chauk.mean at gmail.com>:
> Alex,
>
> 2008/11/10 Alex Fenton <alex at pressure.to>:
>> Chauk-Mean P wrote:
>>> - what about adding the Textile documentation into the source
tarball ?
>>> (this will avoid using subversion just for the documentation).
>>
>> I tested this out and it looks like adding the Textile sources to the
source
>> tarball would increase its size by about 600kb. I''m not sure
this is
>> justifiable on its own as the base tarball is only 1MB. But like
wxWidgets,
>> I guess we could offer a wxruby-src-full tarball with more stuff in it
like
>> textile sources
>
> That''s fine.
>
>> and possibly generated docs.
>
> I don''t think that it is useful. Unlike the textile documentation,
the
> generated docs already has its own tarball.
>
I''ve filed Feature Request #22846.
>>> - can the requirements on wxWidgets be removed for the html_docs
rake task ?
>>
>> Yes, only the textile_docs task depends on the wxWidgets sources being
>> installed. And we never normally need to run this task, except to
generate
>> docs when new classes are added.
I''ve filed Feature Request #22847.

Cheers.

Chauk-Mean.