Commit Graph

58 Commits

Author SHA1 Message Date
df528a9209 Merged changes in the trunk up to revision 32124. 2010-09-25 21:03:16 +00:00
aaf328dc78 remove redundant []'s for list comprehension's, py2.4+ supports this. 2010-09-19 07:07:14 +00:00
9c6feb1987 * Merged changes in the trunk up to revision 31789.
* Made a local fix for a compilation error with VC++ 2008 and
CMake, reported to the bf-committers mailing list:
http://lists.blender.org/pipermail/bf-committers/2010-September/028643.html
2010-09-06 23:26:36 +00:00
0cf0f5a622 rna api
- 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.
2010-09-03 14:53:54 +00:00
52cefa4bc1 sphinx doc gen
- 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.
2010-09-03 09:21:40 +00:00
4fae911383 Merged changes in the trunk up to revision 31440. 2010-08-18 13:16:34 +00:00
b278279c95 document rna functions that have the no_self flag set as classmethods 2010-08-17 14:32:14 +00:00
7a31417f50 apply UserPrefs and Theme rna naming changes. 2010-08-17 13:14:41 +00:00
92478de0eb Merged changes in the trunk up to revision 31403. 2010-08-17 07:10:03 +00:00
78d96324ae Py API Docs (GSoC): Third merging commit
* Added the alternative docs system with templating functionality
* Added aud to sdg.py
2010-08-16 12:22:19 +00:00
47d38dbd20 svn merge -r 31211:31313 https://svn.blender.org/svnroot/bf-blender/trunk/blender 2010-08-13 10:50:29 +00:00
1a875f915d Merged changes in the trunk up to revision 31284. 2010-08-12 13:41:59 +00:00
aae5c9b58d - possibly bugfix /w uninitialized vars [#23270] Long directory name 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()
2010-08-11 22:36:43 +00:00
6cae52bca2 add support for documenting class methods 2010-08-11 17:13:39 +00:00
dd75ec4907 Merged changes in the trunk up to revision 31190. 2010-08-09 11:32:55 +00:00
64b36ffbb3 svn merge -r 31060:31144 https://svn.blender.org/svnroot/bf-blender/trunk/blender 2010-08-07 15:45:07 +00:00
30d180ff0d bugfix [#23194] export UVs miss the extension file
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.
2010-08-06 01:40:54 +00:00
1f7bcf2544 Minor sphinx corrections:
* 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
2010-07-19 13:36:10 +00:00
8ecf072f9a BGE Py API:
* Sphinx autorun file.
* bge modules are now autogenerated
* added aud module
2010-07-16 21:42:20 +00:00
2df7f76e78 Merged changes in the trunk up to revision 30397. 2010-07-15 21:05:11 +00:00
5daf9354d2 change some references to .B.blend, .Blog to new names 2010-07-15 11:51:43 +00:00
b8de9bc5fb Merged changes in the trunk up to revision 29994. 2010-07-05 18:37:29 +00:00
1a6b9ea5d9 == python api docs ==
- 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
2010-06-28 00:06:23 +00:00
768ecb1ba9 api reference docs: include bpy.data in the main page since its used everywhere.
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
2010-06-27 18:34:27 +00:00
4d141cf808 Merged changes in the trunk up to revision 29550. 2010-06-18 22:53:49 +00:00
22bca493b2 == addons ==
- 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
2010-06-17 02:38:49 +00:00
927aac74ab - module for reading blend start/end frames and scene name (useful for finding the total frame count without loading a blend file)
- added render api as unstable to the docs.
2010-06-15 12:06:30 +00:00
8d3a5a8b0a == python api 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
2010-06-15 02:06:01 +00:00
dba99b544b == python api docs ==
* 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)
2010-06-11 22:41:13 +00:00
df0b629e24 Merged changes in the trunk up to revision 29409. 2010-06-11 17:17:02 +00:00
677a0434a4 == python api docs ==
- 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
2010-06-04 13:47:56 +00:00
ca6f7ddd99 Merged changes in the trunk up to revision 29184. 2010-06-03 15:39:02 +00:00
e58bb562d2 == python api 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
2010-06-02 21:28:17 +00:00
286f167845 == Sphinx Doc Gen ==
Workaround to address attribute description issue. 
In resulting .rst file attribute's descriptions appeared
not indented which sphinx considered as anoter blocks.
2010-05-30 00:24:32 +00:00
dbcb73c033 Merged changes in the trunk up to revision 28911. 2010-05-21 22:01:47 +00:00
45444ceee3 include game engine docs in sphinx doc generation:
bge.events, logic, render & types (others still need work)

Updated http://www.blender.org/documentation/250PythonDoc
2010-05-17 20:38:54 +00:00
cfc351afee Merged changes in the trunk up to revision 28772. 2010-05-14 21:50:15 +00:00
c598d90899 Sphinx theme from Alex Sytnik (smerch) for API Docs
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
2010-05-14 10:21:57 +00:00
6d8cb93f71 building docs failed when the output directory didnt alredy exist. 2010-05-09 17:18:57 +00:00
8a20433f0f Merged changes in the trunk up to revision 28600. 2010-05-05 22:57:58 +00:00
914d5e5f62 sphinx doc generation
- include default values as well as min/max.
- partial rebuilds, so we dont have to build all docs each time, only the changed files.
2010-05-03 15:52:15 +00:00
dfe2f8dc03 Merged changes in the trunk up to revision 28247. 2010-04-18 02:03:19 +00:00
11fc330f7e Fix for including docstrings of static methods. 2010-04-13 00:55:37 +00:00
67cfc427ee PyAPI
- 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.
2010-04-11 14:22:27 +00:00
9eb838ce24 bpy.app was writing members more then once. 2010-04-10 19:06:18 +00:00
6e3920e8fa rna/py/reference doc improvements..
- 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.
2010-04-10 18:35:50 +00:00
c3ab6bc509 rna reference docs, list inherited properties and functions at the bottom of each type. 2010-04-09 20:43:58 +00:00
bad41fcff5 - new docstrings for bpy.type.Struct methods & some corrections.
- struct.path_to_id() --> path_from_id().
2010-04-06 07:49:10 +00:00
e302f33be7 document bpy.types.Struct methods C methods, currently only 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
2010-04-05 22:37:09 +00:00
f85bcac8ae Added an entry for the documentation of the Freestyle Python API.
Also fixed a minor bug in sphinx_doc_gen.py that raised a TypeError
when a C extension function does not have a docstring.
2010-04-05 21:06:32 +00:00