Age | Commit message (Collapse) | Author |
|
First commit to make some structure in doc/ directory.
- moved source/blender/python/doc -> doc/python_api
- moved source/gameengine/PyDoc/*.rst -> doc/python_api/rst
- modified accordingly sphinx_doc_gen.py and sphinx_doc_gen.sh
(later on I'll try alternative/ scripts by neXyon as promised :)
- source/gameengine/PyDoc/ is still there because contains epydoc stuff for the bge, will ask more and look into it later
|
|
|
|
- move: material.add_texture(tex, coords, mapto) --> material.texture_slots.add()
- added material.texture_slots.create(index), material.texture_slots.clear(index)
- texture slot functions also work for lamp and world now.
Other minor changes
- allow rna functions to set FUNC_NO_SELF and FUNC_USE_SELF_ID at once.
- [#23317] Changed some operators' RNA to accept lengths, a modification I made to this patch made it not work as intended, removed this edit so unit buttons appier in the UI for certain operators.
- Sphinx doc gen, 2 columns rather then 3, didnt quite fit in some cases.
|
|
- use 3 column lists for inherited props, funcs and for references to save on vertical space.
- use the blender version string for the upload path and PDF name.
|
|
|
|
|
|
* Added the alternative docs system with templating functionality
* Added aud to sdg.py
|
|
https://svn.blender.org/svnroot/bf-blender/trunk/blender
|
|
segmentation fault in File brower.
- in exceptional cases vertcos_to_key() could return with KeyBlock pointing to freed memory.
- invalid use of realloc() in BLI_builddir()
|
|
|
|
https://svn.blender.org/svnroot/bf-blender/trunk/blender
|
|
also made all other exporters do this.
Made some internal changes.
- moved path functions from bpy.utils to bpy.path (similar to os.path)
- added functions...
bpy.path.ensure_ext(path, ".ext", case_sensitive=False) # simple function to ensure the extension is set.
bpy.path.resolve_ncase(path) # useful for importing scenes made on windows where the path case doesnt match the files.
|
|
* Attributes starting with _ in classes are now ignored
* sphinx.blend updated so that it doesn't have to be edited anymore if the script changes
|
|
* Sphinx autorun file.
* bge modules are now autogenerated
* added aud module
|
|
|
|
- properties are now listed on alphabetical order
- readonly properties use "data" directive, so that we see them in green in the web docs
example (after Campbell will rebuild the docs):
http://www.blender.org/documentation/250PythonDoc/bpy.types.RenderLayer.html
(note that green attributes still need final CSS-ing, but smerch is a bit busy atm)
- fixed indentation in http://www.blender.org/documentation/250PythonDoc/bpy.data.html
|
|
since this isnt a module its self its a little odd to do this but toctree cant make arbitrary cross-references.
Also added some usage examples: http://www.blender.org/documentation/250PythonDoc/bpy.data.html
|
|
- release/scripts/ui/space_userpref.py
added the change to add a 'warning' field to bl_addon_info
warning icons are used to show 'broken' scripts or warnings
asked permission to campbell and matt in blendercoders to apply this
- source/blender/python/doc/sphinx_doc_gen.py:
small fix in the url
|
|
finding the total frame count without loading a blend file)
- added render api as unstable to the docs.
|
|
* source/blender/python/doc/sphinx_doc_gen.py:
changed the "undocumented" message so that it still links to
http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute
but uses flags in the url to help documenting.
Example: http://www.blender.org/documentation/250PythonDoc/bpy.ops.node.html#bpy.ops.node.link
click on "contribute", the new section has title "bpy.ops.node.link" and a howto message is shown
* source/blender/python/intern/bpy.c:
fixed a typo
|
|
* source/gameengine/PyDoc/bge.types.rst:
KX_PolygonMaterial was missing the parent class indication (PyObjectPlus)
* source/blender/python/doc/sphinx_doc_gen.py:
* unified all the "undocumented" descriptions, like
http://www.blender.org/documentation/250PythonDoc/bpy.ops.anim.html#bpy.ops.anim.keyframe_delete_button
so that it will be easy for Alex to CCS 'em and also now people will have a link to contribute descriptions,
see http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute
* moved the note about bpy_struct not being available in the api
in a proper note directive, so that it's more evident
(I didn't see it at first)
|
|
- small change to indicate the source file we use the proper :file: directive and we link to proper file in svn
check for example http://www.blender.org/documentation/250PythonDoc/bpy.ops.cloth.html#bpy.ops.cloth.preset_add
after you rebuild the docs
|
|
* source/blender/python/doc/sphinx_doc_gen.py
changed syntax for declating attributes type to use :type: instead of *type* os it
* source/gameengine/Ketsji/KX_PythonInit.cpp
While documenting I've found that we have two naming conventions for constraints in BGE python api,
example: KX_CONSTRAINTACT_DIRPZ and KX_ACT_CONSTRAINT_FHPX: the right convention is KX_CONSTRAINTACT_xxx
After talking with dalai and cambpell we agreed that this kind of change is better suited for NExyon GSoC
so I marked as TODO
Also, found 2 duplicate rows, fixed after askin nexyon
* source/gameengine/PyDoc/bge.logic.rst
there were 2 blocks for constraints, I've put them together in docs and fixed some other lines
* source/gameengine/PyDoc/bge.types.rst
first cleanup: mainly started using ":type:", it was mixed usage of *type* and **type**
started cleaning some bullet list in a way that varibles link to the constant in appropriate page
I'll continue later
|
|
Workaround to address attribute description issue.
In resulting .rst file attribute's descriptions appeared
not indented which sphinx considered as anoter blocks.
|
|
bge.events, logic, render & types (others still need work)
Updated http://www.blender.org/documentation/250PythonDoc
|
|
You wouldnt know its not blender.org :D
http://www.blender.org/documentation/250PythonDoc/mathutils.html
from revision 39 of https://svn.blender.org/svnroot/blend-doc/trunk/python/doc
|
|
|
|
- include default values as well as min/max.
- partial rebuilds, so we dont have to build all docs each time, only the changed files.
|
|
- added new mathutils.Color() type, use with rna so we can do for eg:
material.diffuse_color.r = 1.0
# also has hsv access
material.diffuse_color.s = 0.6
- made Mathutils and Geometry module names lowercase.
|
|
|
|
- vectors now respect min/max settings.
- keyframing and adding drivers raises an error in an index is set on a non array, keyframing raises an error if it fails.
reference docs...
- added docstrings for remaining python bpy_struct functions
- added fake class for docs, bpy_struct, which is the base class of everything in bpy.types
- improved inherictance references for struct classes, include bpy_struct members.
|
|
each type.
|
|
- struct.path_to_id() --> path_from_id().
|
|
keyframe_delete() and keyframe_insert() have useful docstrings.
http://www.blender.org/documentation/250PythonDoc/bpy.types.Struct.html?highlight=bpy.types.struct#bpy.types.Struct.keyframe_insert
|
|
27562, 27570, 27571, 27574, 27576, 27577, 27579, 27590, 27591, 27594, 27595, 27596, 27599, 27605, 27611, 27612, 27613, 27614, 27623
|
|
API Docs title and interactive console banner.
|
|
|
|
This means adding the file "bpy.props.py" in the examples dir will automatically be used when generating docs, unused examples give warnings.
|
|
http://www.blender.org/documentation/250PythonDoc/BLF.html
|
|
|
|
|
|
- bpy.app moved into PyStructSequence (used by sys.float_info)
- added buildinfo into bpy.app.build_*
- bpy.ui removed (wasnt used)
- include external example files in Mathutils docs (only Mathutils and Vector are currently written)
- added support to auto document PyStructSequence's
- CMake had "'s inside all its strings.
|