Campbell Barton
909d74d124
- use python convention for headings
...
- use implicit examples rather than .. code-block::
2011-08-27 08:09:12 +00:00
Campbell Barton
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
Campbell Barton
a9dea3afe9
correct missing bpy doc references.
2011-08-26 18:48:48 +00:00
Campbell Barton
f10f4f570d
added a section to gotcha's python bpy docs about unicode encoding problems.
2011-08-26 18:32:23 +00:00
Campbell Barton
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
Campbell Barton
b7eac1edcf
picky style edits with screen/view/drawing, also remove own bad example doc.
2011-08-25 15:49:52 +00:00
Guillermo S. Romero
38398d200f
SVN maintenance.
2011-08-25 06:16:26 +00:00
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
75a63981cd
add warning about misuse of ID.user_clear() since it can crash blender.
2011-08-23 11:28:18 +00:00
Campbell Barton
ef18ec335f
svn merge -r39145:39286 https://svn.blender.org/svnroot/bf-blender/trunk/blender
2011-08-11 05:04:01 +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
Joerg Mueller
daab78bc61
Merging trunk up to r39145.
2011-08-07 15:25:06 +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
Joerg Mueller
eb9d591898
* Merging trunk up to r38981.
...
* Fixing a minor issue in a previous commit.
2011-08-03 12:44:52 +00:00
Campbell Barton
a10245a1fa
fix [ #28151 ] export OBJ don't save the extension
...
also correct some typos
2011-08-03 05:32:07 +00:00
Joerg Mueller
4e8e502c02
Merging trunk up to r38932.
2011-08-02 12:16:06 +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
Joerg Mueller
29f214f7f3
Merging up to trunk r38834.
2011-07-29 21: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
0facd795f8
automatically update the redirect from http://www.blender.org/documentation/250PythonDoc/ when uploading docs
2011-07-28 03:08:35 +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
Joerg Mueller
4532bd731d
Merge with trunk up to r38584.
2011-07-21 21:11:58 +00:00
Mitchell Stokes
9fa6e32d5c
BGE Animations: Updating the python docs.
2011-07-16 05:29:15 +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
Guillermo S. Romero
74494dbcd2
SVN maintenance.
2011-07-13 00:49:22 +00:00
Joerg Mueller
d9cf985730
Merging trunk up to r38329.
2011-07-12 13:09: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
6aae2698ac
patch [ #27885 ] bge.constraints documentation
...
by Solano Felicio (solano)
2011-07-08 02:59:25 +00:00
Campbell Barton
7ab90056c7
fix for example
2011-07-07 21:14:36 +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
Joerg Mueller
34c5784f99
Merging trunk up to r38167.
2011-07-06 20:26:56 +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
Mitchell Stokes
c1715223b9
BGE Animations: Updating the bge.types docs to include the three new methods to KX_GameObject: playAction(), getActionFrame(), setActionFrame().
2011-07-05 22:32:10 +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
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
69ff819a2e
print the help message if running from python directly.
2011-06-27 04:50:08 +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
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
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
Campbell Barton
2777ba74b0
remove include paths which dont exist, fix for doc upload script which was getting the blender version twice and not working sometimes.
2010-10-27 13:52:12 +00:00
Campbell Barton
3264ced377
move geometry python module into mathutils.geometry, since it provides utility functions using mathutils types.
2010-10-25 22:44:01 +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