[Bf-committers] Python RNA/API help/todo's

[Campbell Barton]

On Tue, Apr 13, 2010 at 2:34 PM, Campbell Barton <ideasman42 at gmail.com> wrote:
> Over the weekend I tried to tie up loose ends in the documentation
> generation system and now I think its mostly finished.
> Most importantly, useful internal functions like these are now
> included in the docs.
>
> http://www.blender.org/documentation/250PythonDoc/bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert
> http://www.blender.org/documentation/250PythonDoc/bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id
>
> ...as well as an inheritance reference for functions and properties,
> so you can look at any page and know all available functions &
> attributes at a glance.
> http://www.blender.org/documentation/250PythonDoc/bpy.types.Group.html#bpy.types.Group
>
>
>
> With this done there are some todo's others might like to look into.
>
> - list add/remove functions that are missing.
>  eg: http://www.blender.org/documentation/250PythonDoc/bpy.types.TimelineMarkers.html#bpy.types.TimelineMarkers.add
>  but this doesn't exist for all data types,
>  look at this big list for items that can be added and removed, make
> a list of whats missing from our api
> http://www.blender.org/documentation/250PythonDoc/bpy.types.html
>  Example http://www.blender.org/documentation/250PythonDoc/bpy.types.RenderResult.html#bpy.types.RenderResult.layers
> cant add or remove layers yet.
> - Going ahead and writing add/remove functions would also help a lot :)
> - review limits, many are obviously wrong  eg:
> http://www.blender.org/documentation/250PythonDoc/bpy.types.SmoothModifier.html#bpy.types.SmoothModifier.repeat
> - write missing docstrings (boring but easy if you learn the api -
> would be great if someone could write these
> http://www.blender.org/documentation/250PythonDoc/bpy.types.UILayout.html#bpy.types.UILayout).
> - *fun* Sphinx blender theme, see
> http://pythonic.pocoo.org/2010/1/8/new-themes-in-sphinx-1-0
>
> --
> - Campbell

For those who don't read commit logs, thanks to Alex Sytnik for making
a blender theme for sphinx
eg: http://www.blender.org/documentation/250PythonDoc/mathutils.html

-- 
- Campbell