Commit Graph

37 Commits

Author SHA1 Message Date
Campbell Barton
e2818f1b92 - include enum names and descriptions in sphinx generated documentation
- add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
Campbell Barton
7500f4cd48 fix for misc py errors + some pep8 edits. 2011-09-08 05:42:44 +00:00
Campbell Barton
b7eac1edcf picky style edits with screen/view/drawing, also remove own bad example doc. 2011-08-25 15:49:52 +00:00
Campbell Barton
75a63981cd add warning about misuse of ID.user_clear() since it can crash blender. 2011-08-23 11:28:18 +00:00
Campbell Barton
2658949752 pep8 cleanup, also print message when attempting to run in animation player mode. 2011-07-29 01:24:03 +00:00
Campbell Barton
71692e802f py api:
- added menu templates
- move template menu into the header of the text editor (so users will find more easily)
- updated mathutils examples, switching the order of multiplication.
2011-07-26 07:39:00 +00:00
Guillermo S. Romero
74494dbcd2 SVN maintenance. 2011-07-13 00:49:22 +00:00
Dalai Felinto
936737b70f example of Physics Constraints module :)
+ some small fixes in other docs.

A topic for later(soon?), I think we should name the modules according to the rest of Blender modules. So instead of:
Game Engine bge.logic Module

We would have it:
Game Logic (bge.logic)
...
2011-07-08 06:51:12 +00:00
Campbell Barton
7ab90056c7 fix for example 2011-07-07 21:14:36 +00:00
Dalai Felinto
4260258bb3 an example for blf - a basic Hello World (for bge, not blender) 2011-07-06 08:29:20 +00:00
Dalai Felinto
2691c6a84f new example for bge.texture, a basic texture replacement
fresh simple and didactic example straight from my bge book, enjoy it ;)
video texture documentation online ... tears dropping.
2011-07-06 07:26:04 +00:00
Dalai Felinto
b9810ffdde moving bge.texture example to an external file 2011-07-06 07:15:56 +00:00
Campbell Barton
93bb6238e0 remove some unused flags and correct aud example heading 2011-06-27 07:44:59 +00:00
Dalai Felinto
9dbec62bc0 basic sound playback example for audspace module
(I'm on windows at the moment so I can't test it. Hopefully it should be fine)
2011-06-27 05:12:03 +00:00
Campbell Barton
eaae38551f pep8 compliance 2011-06-21 17:17:51 +00:00
Campbell Barton
97a85fe100 - add example for python rna property update
- edit the copyright for blender specific cmake find modules
2011-06-20 02:54:56 +00:00
Campbell Barton
26252bb315 correct spelling error and some pep8 changes. 2011-05-26 09:33:51 +00:00
Campbell Barton
15289c6048 use PyDoc_STRVAR macro, so its possible to build without docstrings. 2011-05-24 16:05:51 +00:00
Campbell Barton
357ce16958 loading data with bpy.data.libraries.load(), now swaps out the strings in the list to load with the actual datablocks, this is convenient because it saves the script author having to find them after.
also raise warnings rather then errors if the datablock can't be found.
2011-05-24 15:21:14 +00:00
Campbell Barton
f3a9b7580e spelling corrections. 2011-04-29 04:43:36 +00:00
Campbell Barton
dbd3009108 - background job style cleanup.
- assert if material assignment is called with lib. (so the callers can be corrected).
- correct example docs
2011-04-10 15:24:05 +00:00
Campbell Barton
e6c30a41ea can't include titles in function examples. 2011-04-08 05:03:02 +00:00
Campbell Barton
233d8594fc [#26768] 2.57 - sys.path not initialized properly
we should document this properly (we only have general design docs atm), for now just correct the tooltip.

also update api example docs.
2011-04-04 05:47:04 +00:00
Campbell Barton
2900557568 examples for keyframing nested paths. based on report from user der_On's report [#25746] 2011-03-31 12:45:54 +00:00
Campbell Barton
04e32be958 optparse module is deprecated, use new argparse module in background job template.
correction to example in doc too.
2011-03-26 03:42:59 +00:00
Campbell Barton
35dae4f0b5 add sphinx api reference note that menu's layout.operator_context defaults to EXEC_REGION_WIN rather then INVOKE_DEFAULT. 2011-03-17 22:49:46 +00:00
Campbell Barton
2d1ef275f2 bpy.types.libraries.load sphinx doc & examples (doc system needed some updates).
http://www.blender.org/documentation/blender_python_api_2_56_3/bpy.types.BlendDataLibraries.html#bpy.types.BlendDataLibraries.load
2011-03-14 10:31:50 +00:00
Campbell Barton
bc15e0e295 add NDEBUG to scons release flags + some pep8 cleanup for examples. 2011-02-25 16:19:50 +00:00
Campbell Barton
93d562b7b6 correct example 2011-02-22 04:42:21 +00:00
Guillermo S. Romero
24d7606cb8 SVN maintenance. 2011-02-18 19:33:19 +00:00
Campbell Barton
251d27110b examples for bpy.props 2011-02-18 14:27:18 +00:00
Campbell Barton
5531f3093a render engine example thanks to dougal2. 2011-02-18 13:40:13 +00:00
Campbell Barton
063a7f217b python api docs & examples for registrable Menu/Panel/Operator/PropertyGroup classes. 2011-02-18 08:47:37 +00:00
Campbell Barton
aed7eaf0d9 sphinx doc gen: multiple examples possible and include the scripts docstring inline in sphinx.
also tag unused vars
2011-02-16 17:31:04 +00:00
Campbell Barton
fee5363912 bugfix [#26094] Going to Bone Roll menu brings up python error
also correct for pep8 warnings.
2011-02-16 02:25:03 +00:00
Campbell Barton
998198a041 mathutils rotate functions for Euler/Quaternion/Matrix/Vector types.
each accept Euler/Quaternion/Matrix types.

eg:
  Euler.rotate(Quaternion(axis, angle))
  Vector.rotate(Euler((pi/2, 0, 0)))

matrix.resize_4x4() and euler.make_compatible() were still returning an instance of themselves, now return None.
2011-02-05 09:57:02 +00:00
Luca Bonavita
996efebbe3 == python api doc ==
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
2010-10-13 10:42:33 +00:00