Commit Graph

24 Commits

Author SHA1 Message Date
Campbell Barton 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
Campbell Barton da6bc69ca9 fix [#28191] Exception when enabling a script for a newer Blender build 2011-08-09 14:16:22 +00:00
Campbell Barton 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
Campbell Barton 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
Campbell Barton 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
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 6aae2698ac patch [#27885] bge.constraints documentation
by Solano Felicio (solano)
2011-07-08 02:59:25 +00:00
Campbell Barton 9a0de18a52 bge.texture doc, needed whitespace to format correctly. 2011-07-07 19:35:55 +00:00
Campbell Barton af27622a87 some corrections to bge.texture docs 2011-07-07 19:23:51 +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
Campbell Barton 01550f880e add 'bgl' OpenGL doc to sphinx 2011-07-01 11:16:42 +00:00
Campbell Barton 5916309ac9 moving BGL to rst format, first move file. 2011-07-01 11:13:26 +00:00
Campbell Barton e1ba5c8167 moved modules added to changelog (this isn't detected by the changelog generator) 2011-06-27 04:21:53 +00:00
Campbell Barton fb1ded6572 update automatic rna changelog 2011-06-22 12:05:24 +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 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 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
mindrones 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