[Bf-python] Re: Documentation (was Re: metaballs)

[Ramanan Selvaratnam]

Hi,

I am lurking here following  the docboard announcement.

But not too sure yet ...whether I will find the time to be realistically 
helpful.

If I can make it to the IRC meting schedule for Sat. then I am in.

Regards,

Ramanan

Ton Roosendaal wrote:

> Hi,
>
> I have contacted the docboard, no reaction so far. I am afraid there 
> is  no volunteer there...
>
> -Ton-
>
>
>> Hi,
>>
>> (I cc-ed this mail to Ton, because of some docboard actions :) )
>>
>> On Wed, 2003-05-21 at 12:36, Jordi Rovira i Bonet wrote:
>>
>>> Michel Selten wrote:
>>>
>>>> Since you are writing new modules, that have no specified api yet, a
>>>> little document is asked. This has been decided on at the last  
>>>> meeting.
>>>>
>>>
>>> Hello,
>>>
>>>   I have the same documenting problem with the Armatures module. A
>>> template for writting the API reference (which is something the
>>> developer of each module should do) would be very valuable here.
>>> Something like the Docbook XML templates that the documentation 
>>> board  is
>>> using. How could this be arranged?
>>
>>
>> Ton was going to contact the docboard for help on documenting the api.
>> See the meeting minutes from last sunday (18th). I don't know what the
>> result is yet.
>>
>> For now, I would suggest to look at how the api was documented for  
>> 2.25.
>> Simply write down the functions and methods descriptions in an ascii
>> file would suffice for now I guess. I know, the layout will be a bit
>> difficult, but that's where the docboard can come in I think.
>>
>>>   Anybody here is part of the docboard too? Should we ask them to do
>>> this template for us?
>>
>>
>> That's a good idea, let's just wait for Ton a few days to react.
>>
>> With regards,
>>     Michel
>>
>> ps. Maybe we could use OpenOffice? It seems that the new version (to be
>> released somewhere in June or so) is capable of exporting to DocBook  
>> and
>> pdf.
>>
>>
>>
> ------------------------------------------------------------------------ 
> -- 
> Ton Roosendaal  Blender Foundation ton at blender.org
>
> _______________________________________________
> Bf-python mailing list
> Bf-python at blender.org
> http://www.blender.org/mailman/listinfo/bf-python
>
>