[Bf-python] Automatic documentation : ) !

Ramanan Selvaratnam rama at uklinux.net
Thu Jun 19 02:59:39 CEST 2003


Michel Selten wrote:

>On Wed, 2003-06-18 at 21:50, Ramanan Selvaratnam wrote:
>  
>
>>So can some one specify, who is the intended audience for anything w.r.t 
>>python in the Blender docs?
>>-- those who already know python or similar (ie, be able to understand 
>>the any such 'epydoc' [1] generated API)
>>-- beginners who want to understand what this is all about and possbily 
>>progress through to scripting
>>-- or any other middleground ....
>>    
>>
>
>The intended audience is the user base of Blender. In other words those
>who want to write a script to use in a .blend file. This will be the
>main reference for the users wanting to write scripts.
>
Thanks. Now what we need to ascertain is whether there is someone 
already  on the case.
I noticed sometime back there was mention of Python documentation on the 
[bf-docboard].
 
If there is someone  working on it I will like to join in.
Otherwise  I can do an outline to fit a model as described above and see 
where we go from there.

(This  is  cross posted to the [bf-docboard])

>
>Doxygen will be used to write the documents intended for developers who
>want to implement new features in the Python API. 
>
A sort of an apendix  to the forthcoming blender manual, I guess (?)

>In other words, it
>will be used to describe the internals that part of Blender.
>
>With regards,
>	Michel
>
>
>_______________________________________________
>Bf-python mailing list
>Bf-python at blender.org
>http://www.blender.org/mailman/listinfo/bf-python
>
>
>  
>





More information about the Bf-python mailing list