Commit Graph

90 Commits

Author SHA1 Message Date
909d74d124 - use python convention for headings
- use implicit examples rather than .. code-block::
2011-08-27 08:09:12 +00:00
2e8771e987 bpy Gotcha's section on bones by Bassam Kurdali, with some edit.
added some examples & notes too.
2011-08-27 07:05:04 +00:00
a9dea3afe9 correct missing bpy doc references. 2011-08-26 18:48:48 +00:00
f10f4f570d added a section to gotcha's python bpy docs about unicode encoding problems. 2011-08-26 18:32:23 +00:00
e9ca846018 document some of the pitfalls in the blender python api (taken from frequent mails and bug reports) 2011-08-26 04:00:55 +00:00
b7eac1edcf picky style edits with screen/view/drawing, also remove own bad example doc. 2011-08-25 15:49:52 +00:00
38398d200f SVN maintenance. 2011-08-25 06:16:26 +00:00
50a9454e0f move wiki api intro and overview docs into the api reference docs.
Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
75a63981cd add warning about misuse of ID.user_clear() since it can crash blender. 2011-08-23 11:28:18 +00:00
da6bc69ca9 fix [#28191] Exception when enabling a script for a newer Blender build 2011-08-09 14:16:22 +00:00
08e184f302 note to address issue raised by report [#28190]. 2011-08-09 13:50:27 +00:00
Dalai Felinto
f3c40df5e3 rst API doc fixes: literalincluding bge.texture and bge.constraints examples + bgl fixes 2011-08-04 09:47:40 +00:00
a10245a1fa fix [#28151] export OBJ don't save the extension
also correct some typos
2011-08-03 05:32:07 +00:00
f4293067c1 py api: sphinx doc corrections, pep8 cleanup and style edits, also added __all__ to some modules which were missing it. 2011-07-31 03:15:37 +00:00
Dalai Felinto
dfc661565a patch [#27909] Added constants in bge.constraints by Solano Felicio (solano) + some changes in rst
I named all the BGE modules with their actual names (e.g. Rasterizer, Video Texture, ...). so in the API index.html page they look more like the other Blender modules.
I did the same for the bgl module.

For bge.constraints this patch exposes the constants values for debug mode and createConstraints (they were hardcoded innts before).

+ making all the "todo" and #comments into rst comments (.. comments)
Thanks Solano, it's great to get help to those tasks :)
2011-07-30 23:16:22 +00:00
2658949752 pep8 cleanup, also print message when attempting to run in animation player mode. 2011-07-29 01:24:03 +00:00
0facd795f8 automatically update the redirect from http://www.blender.org/documentation/250PythonDoc/ when uploading docs 2011-07-28 03:08:35 +00:00
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
0a46f9a737 rename bgl.Buffer attribute list to a method, to_list() as used for IDProps, also made repr function nicer. 2011-07-13 23:45:47 +00:00
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
6aae2698ac patch [#27885] bge.constraints documentation
by Solano Felicio (solano)
2011-07-08 02:59:25 +00:00
7ab90056c7 fix for example 2011-07-07 21:14:36 +00:00
9a0de18a52 bge.texture doc, needed whitespace to format correctly. 2011-07-07 19:35:55 +00:00
af27622a87 some corrections to bge.texture docs 2011-07-07 19:23:51 +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
Dalai Felinto
26d75618ef patch [#27871] bge.texture documentation from Solano Felício (+ changes from me) it still needs work
... and I can't test rst in windows so for now let's pretend it builds. If someone can generate the docs and see how it goes please let me know.

(plus a small fix for bge.logic rst)
2011-07-06 07:05:29 +00:00
01550f880e add 'bgl' OpenGL doc to sphinx 2011-07-01 11:16:42 +00:00
5916309ac9 moving BGL to rst format, first move file. 2011-07-01 11:13:26 +00:00
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
69ff819a2e print the help message if running from python directly. 2011-06-27 04:50:08 +00:00
e1ba5c8167 moved modules added to changelog (this isn't detected by the changelog generator) 2011-06-27 04:21:53 +00:00
fb1ded6572 update automatic rna changelog 2011-06-22 12:05:24 +00:00
eaae38551f pep8 compliance 2011-06-21 17:17:51 +00:00
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
30823cbb87 Python Docs: update layout.html to match blender.org development submenu changes. 2011-06-16 16:13:26 +00:00
ce914e51ab fix [#27659] Segfault when adding None to a group 2011-06-14 09:41:29 +00:00
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
a9dd90be78 move load_image into image_utils and add some docstrings to bpy_extras module. 2011-05-28 09:34:45 +00:00
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
26252bb315 correct spelling error and some pep8 changes. 2011-05-26 09:33:51 +00:00
15289c6048 use PyDoc_STRVAR macro, so its possible to build without docstrings. 2011-05-24 16:05:51 +00:00
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
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
f3a9b7580e spelling corrections. 2011-04-29 04:43:36 +00:00
9ba543a522 minor improvements to sphinx doc main page 2011-04-13 14:43:11 +00:00