Commit Graph

53 Commits

Author SHA1 Message Date
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
Brecht Van Lommel
30823cbb87 Python Docs: update layout.html to match blender.org development submenu changes. 2011-06-16 16:13:26 +00:00
Campbell Barton
ce914e51ab fix [#27659] Segfault when adding None to a group 2011-06-14 09:41:29 +00:00
Campbell Barton
214f4e8c03 include some useful info in bge docs, by ZiauddinMK on IRC. 2011-06-14 07:46:38 +00:00
Dalai Felinto
a2dda7c74d BGE Patch: [#27425] Allow to change the damping of the camera actuator
##########
original name: "Allow to change the strenght of the "go behind" constraint of the camera actuator"

The camera actuator is an actuator that drive the camera to follow an object, with a set of constraint.
Currently, when the object followed rotate on himself (like a person, or an helicopter), the camera is really slow to go behind (at least 10 seconds).

This patch gives the UI to tweak the strenght of the 'go behind'[named damping] constraint.
###########

epydocs (rst) updated too
2011-06-13 17:08:33 +00:00
Campbell Barton
a9dd90be78 move load_image into image_utils and add some docstrings to bpy_extras module. 2011-05-28 09:34:45 +00:00
Campbell Barton
ecf2d1ff4e - generate sphinx docs for bpy_extras module
- add in support to doc generator for automatically generating docs for submodules.
2011-05-28 07:47:58 +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
05a78baa87 sphinx api docs: fix for addons linking to the wrong operator SVN url's.
also change from blender from 'release' back to beta so new docs don't overwrite the 2.57b release docs.
2011-05-05 14:45:24 +00:00
Campbell Barton
f3a9b7580e spelling corrections. 2011-04-29 04:43:36 +00:00
Campbell Barton
9ba543a522 minor improvements to sphinx doc main page 2011-04-13 14:43:11 +00:00
Campbell Barton
2ed8b5f679 reference the release PDF correctly 2011-04-12 16:56:15 +00:00
Campbell Barton
ba03e5023e less alarming warnings about the python api not being stable in online docs and remove from interactive console. 2011-04-12 12:09:38 +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
28594bc742 minor pep8 edits, also added 'test_pep8' & 'test_cmake' to the GNUmakefile for convenience. 2011-04-10 10:45:56 +00:00
Campbell Barton
e6c30a41ea can't include titles in function examples. 2011-04-08 05:03:02 +00:00
Campbell Barton
24b012c978 Sphinx RNA API changelog generator.
- lists added and removed functions and properties.
- lists renamed properties (does fuzzy comparison using min/max, description, type)
- lists functions with arguments changed.

Committed change log from 2.56 -> 2.57:
  http://www.blender.org/documentation/250PythonDoc/change_log.html
2011-04-07 07:53:28 +00:00
Mitchell Stokes
8d100c032e Updating BGE dynamic loading docs:
* Adding load_action and verbose keyword args for LibLoad()
  * Adding LibList()
2011-04-07 04:00:56 +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
3ddbb36fa7 modification to api docs so release point to:
http://www.blender.org/documentation/blender_python_api_2_57b_release

Development versions point to:
   http://www.blender.org/documentation/blender_python_api_2_57_0

This way updates to api docs after release wont overwrite release docs.
2011-04-01 15:13:58 +00:00
Campbell Barton
d4a9bc1c21 while looking into adding back brush tool keys found mixed texture/image paint rna vars, using 'image paint' internally. 2011-04-01 04:22:30 +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
50a06eccff pep8 cleanup 2011-03-27 05:23:14 +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
1b80538fea fix [#25688] undocumted functions in pyapi
expose collection function docs.
2011-03-22 04:28:51 +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
dd8383e469 make doc generation close files (py3.2 complains about this),
minor formatting changes for C docstrings.
2011-02-22 05:23:20 +00:00
Campbell Barton
93d562b7b6 correct example 2011-02-22 04:42:21 +00:00
Campbell Barton
e46da7166b remove BGE's PyObjectPlus.isA method docs, was removed in favor of built-in isinstance(), report [#26080]. 2011-02-21 10:15:19 +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
7748860aeb doc generation support for excluding some modules, without this a full rebuild takes too long to test changes.
also include own function definitions for blf_dir.c.
2011-02-16 05:18:10 +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
cb12d708c7 Doc generator now makes 'bpy.context' api reference.
http://www.blender.org/documentation/250PythonDoc/bpy.context.html

strings are extracted from blender to ensure all values are included, currently there is no type info so this is stored in the doc generator.
2011-02-15 15:37:40 +00:00
Campbell Barton
1cdab667bc - cmake was missing an inclide (IDE's wouldnt index)
- made doc generation always sumlink newly built docs to static URL. http://www.blender.org/documentation/250PythonDoc/
2011-02-06 10:18:20 +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
Campbell Barton
736a7b7a22 pep8 cleanup 2011-02-04 09:27:25 +00:00
Campbell Barton
ce7f7d6e5f r34526 removed a line which had an unused return value but still needed to run. 2011-01-27 12:36:48 +00:00
Campbell Barton
577e3b435e removing epydocs for mathutils and geometry mododules (now they are in sphinx) 2011-01-01 23:53:48 +00:00
Campbell Barton
54343b79e6 remove reload() from builtins since python3 no longer uses this.
use imp.reload now.

Should use import hooks but for now replace imp.reload with our own reload as the builtin reload was replaced before.
2010-12-22 21:39:48 +00:00
Campbell Barton
b4081bfc7b patch [#25027] formatting mathutils.geometry module docs for sphinx
from Luka Bonavita

See:
http://www.blender.org/documentation/250PythonDoc/mathutils.geometry.html
2010-12-10 00:20:32 +00:00
Campbell Barton
25bd57b0a1 include getset's for generating module docs.
used for bpy.debug/tempdir/driver_namespace which were previously undocumented.
2010-12-06 12:36:55 +00:00
Luca Bonavita
56f8ced34f == console ==
- banner formatting

== sphinx doc ==

- bpy.data: put the example below the documentation itself
2010-11-25 14:55:03 +00:00