Commit Graph

622 Commits

Author SHA1 Message Date
Campbell Barton
92bc72dca1 convenience targets for make doc_py, doc_dna, doc_man 2011-10-16 11:09:15 +00:00
Campbell Barton
c40b976ea8 py docs - gpu module wasn't included in docs.
also added convenience target to build sphinx api docs:
 make doc_py
2011-10-13 06:59:09 +00:00
Campbell Barton
e3be5aacf8 fix [#28873] Blenders Python API Sphinx Build Script give exceptions 2011-10-11 23:27:01 +00:00
Nathan Letwory
6b2dd62c64 Commit testing notifier hack 2011-10-11 17:30:08 +00:00
Campbell Barton
1fd55c3130 update to cmake doc, still needs more work but update references to CVS and MSVC2005 and Python3.1 2011-10-10 04:16:16 +00:00
Campbell Barton
14dd4d19ed update generated api changelog for edits since 2.59 2011-10-05 22:43:00 +00:00
Campbell Barton
78968a0fc9 fix for mistake in api changelog script with function names. 2011-10-02 23:53:41 +00:00
Campbell Barton
a80520804a add '2.58 to 2.59' to changelog (should have done this for 2.59 release) and texface changes for 2.59 -> 2.60. 2011-10-02 23:47:05 +00:00
Campbell Barton
447a60b7c4 svn merge -rHEAD:40523 doc/python_api/rst/change_log.rst
revert changes for texface, will apply manually after.
2011-10-02 23:23:45 +00:00
Joerg Mueller
a4a09fc638 Fix for [#28792] Invalid 'aud' documentation examples. 2011-10-02 18:00:06 +00:00
Campbell Barton
081543fee8 fix for error generating docs, write all files as utf-8 2011-09-29 12:11:58 +00:00
Dalai Felinto
11a0e00819 BGE Material settings renaming Back Culling to Backface Culling and make it on by default
under suggestion of Mitchell Stokes (Moguri)
2011-09-26 06:39:19 +00:00
Dalai Felinto
51555877b0 manual update on changelog (python API)
Change as suggested by Campbell.
I'm not sure if this is the way to do for enums, I will check with him later
2011-09-24 23:50:00 +00:00
Dalai Felinto
e5b98f7a2f Python API changelog r37840-40524 (HEAD)
updating the doc.

I'm also including the latest API dump with it. This helps to keep track of the revisions to update and the next person updating doesnt need to build an old Blender for that (as I just had to).

I updated the sphinx_changelog_gen.py with this info as well.
I'll update changelog.rst manually next. I'm not so sure how to indicate that the properties were replaced instead of only removed.
2011-09-24 22:40:56 +00:00
Campbell Barton
48918130a1 remove redundant code & use GL_LINE_STRIP for object spiral drawing. 2011-09-22 18:42:16 +00:00
Campbell Barton
8f5112f191 pep8 update & some minor cmake edits. 2011-09-20 18:29:19 +00:00
Campbell Barton
00de0cd6a7 fix for warnings after texface commit, also comment blender sphinx theme for api reference until we get an update for 'Naiad' 2011-09-20 01:35:39 +00:00
Campbell Barton
862aababb3 - remove deprecated pose channel members
- change short -> char for flags that support it.
- add pose 'temp' pointer to use for outliner drawing (was using 'prev' and restoring which seems dodjy)
2011-09-16 02:42:50 +00:00
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
5ba213a424 move utf8 string.c functions into their own file, also add python tip for printing operators. 2011-09-15 08:07:42 +00:00
Campbell Barton
1e6dbb1a4d added section about editmode switching to gotchas 2011-09-10 23:06:44 +00:00
Campbell Barton
e883de2739 spelling corrections from Philippe Casteleyn 2011-09-10 14:28:13 +00:00
Benoit Bolsee
01744abd81 GPU: add gpu python module with export_shader() function to export GLSL shader.
shader = gpu.export_shader(scene,material) 

Returns the GLSL shader that blender generates to produce the visual effect
of material in scene for the purpose of reusing the shader in an external engine.
This function is meant to be used in a material exporter so that the GLSL
shader can be exported entirely. The return value is a dictionary containing the
shader source code and all associated data. 

The full documentation is under sphinx.

Warning: there has been an API between the patch and this commit:
uniform['lamp'] and uniform['image'] now return python reference to 
ID block instead of ID name as before. The X3D exporter that uses this
function must be adapted.
2011-09-09 11:55:38 +00:00
Campbell Barton
4eb9b9e4f1 bpy api - add new page for best-practice (so Thomas has something to point to when kicking devs for writing shoddy UI layouts) 2011-09-08 23:59:47 +00:00
Campbell Barton
49547241d6 correction to docs. 2011-09-08 10:15:27 +00:00
Campbell Barton
7500f4cd48 fix for misc py errors + some pep8 edits. 2011-09-08 05:42:44 +00:00
Campbell Barton
290ad64a22 finished tips and tricks section of blender/python api docs, now included in generated docs. 2011-09-08 01:26:23 +00:00
Campbell Barton
520778163d interface + naming improvements to vertex wright modifier
- WeightVG -> Vertex Weight
- mapping_mode -> falloff_type
- nicer layout for VertexWeightModifiers add/remove options
2011-09-07 07:46:26 +00:00
Campbell Barton
fa32395b33 more minor doc fixes 2011-09-06 00:41:28 +00:00
Campbell Barton
67712c10c4 fix for doc building after pepper merge, also WIP tips/tricks. 2011-09-06 00:12:34 +00:00
Mitchell Stokes
4280e0a04f BGE animations: adding a missing comma. 2011-09-02 03:57:37 +00:00
Campbell Barton
255a81c3bf wip doc for py api tips and tricks. 2011-09-01 07:07:18 +00:00
Mitchell Stokes
1ad8ed8a60 BGE animations: Updating some constant names. They were still the originally proposed names instead of the ones that are actually used now. 2011-08-31 23:46:31 +00:00
Mitchell Stokes
812d5d2e5c BGE Animations: The return type for KX_GameObject.getActionFrame() was an integer when it should have been a float. I've fixed this and converted the tabs in the new BGE animation docs to space. I have also added more info on return types for KX_GameObject.getActionFrame() and KX_GameObject.isPlayingAction(). 2011-08-31 22:32:14 +00:00
Mitchell Stokes
f63d049adc BGE: Adding two new functions to bge.render to allow users to change the anisotropic filtering level used by textures:
* setAnisotropicFiltering(level)
  * getAnisotropicFiltering()
2011-08-31 05:51:51 +00:00
Campbell Barton
b20c9b0ba3 minor edits, pep8 - also correct float -> double promotion for blf. 2011-08-30 10:49:58 +00:00
Joerg Mueller
43ab8e8624 * Merge trunk up to r39790.
* Subversion bump (also for init_userdef_do_versions).
* Minor fix for compilation without ffmpeg.
2011-08-30 08:22:03 +00:00
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
Joerg Mueller
f0d5abfcb2 Merging trunk up to r39637. 2011-08-22 20:31:46 +00:00
Sergey Sharybin
36f20f162c Fix #28154: linux3-config.py doesn't exist
Change OURPLATFORM from "linux<major_version>" to simple "linux".
Since new policy for linux kernel versions that major version in
platform doesn't make much sense for building rules so the same
rules could be used for both of linux2 and linux3 now/

Tested on both of linux2 and linux3 systems.
2011-08-21 13:31:46 +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
Campbell Barton
f98e2161d0 change doxygen string to 2.59 2011-08-09 07:48:40 +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
Nathan Letwory
3c8056a40b Bump version in Doxyfile. 2011-06-21 19:31:06 +00:00
Campbell Barton
eaae38551f pep8 compliance 2011-06-21 17:17:51 +00:00
Campbell Barton
b73caa63c0 correct FSF address, as pointed out by Dave Plater 2011-06-21 05:01:54 +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
1915f1b1e2 quiet 2 compiler warnings and update man page 2011-06-04 03:07:56 +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
Brecht Van Lommel
3a34dcde68 Code cleanup: remove readblenfile module, only contained some utility functions
to read .blend files from runtimes, folded those into blenloader.
2011-05-11 19:29:23 +00:00
Brecht Van Lommel
cb12337363 Code cleanup: remove source/kernel module, this wasn't really the kernel of
anything, only contained a hash map and functions to pass command line args
to the game engine. Moved those to container and BlenderRoutines modules.
2011-05-06 20:18:42 +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
Nathan Letwory
04af4f7c23 Version bump for doxygen. 2011-04-13 08:47:35 +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
162d02bf50 quiet warning & minor pep8 edits. 2011-04-04 22:42:43 +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
Nathan Letwory
e62063bd5c Cleanup paths after move to dir. 2011-02-28 09:58:53 +00:00
Nathan Letwory
1af13dea62 move doxygen files into own subdir. 2011-02-27 20:46:25 +00:00
Nathan Letwory
5fe1c42575 doxygen: update for tagged modules. 2011-02-27 20:44:37 +00:00
Nathan Letwory
a100993878 doxygen: blender/readblenfile tagged. 2011-02-27 19:59:59 +00:00
Campbell Barton
bc15e0e295 add NDEBUG to scons release flags + some pep8 cleanup for examples. 2011-02-25 16:19:50 +00:00
Nathan Letwory
7184ed446b doxygen: kernel/ groups added. 2011-02-25 13:28:22 +00:00
Nathan Letwory
710d79925b doxygen: add missing group definitions. 2011-02-25 13:14:27 +00:00
Nathan Letwory
48dba3bbde doxygen: add bsp group 2011-02-25 11:53:23 +00:00
Nathan Letwory
83d6e06af5 doxygen: update Doxyfile and split doxygen.main 2011-02-25 10:34:04 +00:00
Nathan Letwory
1f4fc992ef doxygen: bge scenegraph and videotexture 2011-02-22 19:30:37 +00:00
Nathan Letwory
5e41760a15 doxygen: add bullet to extern libs, some small changes in page names, and fixes around license blocks 2011-02-22 16:12:12 +00:00
Nathan Letwory
79f79e0cac doxygen: BGE Network, Physics, Rasterizer 2011-02-22 12:42:55 +00:00
Nathan Letwory
5138615554 doxygen: entries for blenderroutines, converter, expressions, gamelogic, gameplayer, ketsji 2011-02-22 10:33:14 +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
Nathan Letwory
212d67734c doxygen: add guardedalloc and AVI 2011-02-21 09:23:34 +00:00
Nathan Letwory
b276624f33 doxygen: footer template 2011-02-21 09:09:27 +00:00
Nathan Letwory
8172207d20 doxygen: editor entry 2011-02-21 07:25:24 +00:00
Nathan Letwory
8c8ae3dedf doxygen: entry for gpu, modifiers, nodes, python and render 2011-02-21 06:58:46 +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
Nathan Letwory
b97ad119b9 doxygen: add blenlib under core as module. 2011-02-18 13:58:08 +00:00
Campbell Barton
5531f3093a render engine example thanks to dougal2. 2011-02-18 13:40:13 +00:00
Nathan Letwory
22638e22ea doxygen: blenkernel under core as module. 2011-02-18 13:05:18 +00:00
Nathan Letwory
b74601078d doxygen: readblenfile part of data group 2011-02-18 10:35:37 +00:00
Campbell Barton
063a7f217b python api docs & examples for registrable Menu/Panel/Operator/PropertyGroup classes. 2011-02-18 08:47:37 +00:00
Nathan Letwory
9e6e34df6c Bring blenloader module under data group. Rename the group to look a bit more sensible in the output. 2011-02-17 23:34:07 +00:00
Nathan Letwory
f697247f0e Start simple intros for intern and extern libs.
Some reorg of modules/pages, start makesdna and makesrna.
In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
Nathan Letwory
f336b80d7f Starting work on doxygen cleanup. Many things still to be done. 2011-02-17 05:57:18 +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
89c617a116 remove nan-makefiles 2011-01-30 15:29:22 +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
8cf0d64623 option for blender --addons rigify,io_scene_fbx,add_mesh_gears
needed so ctest unit testing can be done on addons that are not enabled by default.
2011-01-26 16:30:12 +00:00
Campbell Barton
1bd0db59f4 use cmake defined names for jpeg, png, zlib and python libs, building on *nix with non-standard libjpeg/png/zlib locations was broken.
in the case of python this makes it easier to move to find_package(PythonLibs) when 3.x is supported.
2011-01-25 14:43:13 +00:00
Campbell Barton
f0d9ff34af Command line options to set blender system environment variables.
Added because CTest has no convenient way to set environment vars for commands it runs.

 --env-system-config -> BLENDER_SYSTEM_CONFIG
 --env-system-datafiles -> BLENDER_SYSTEM_DATAFILES
 --env-system-scripts -> BLENDER_SYSTEM_SCRIPTS
 --env-system-plugins -> BLENDER_SYSTEM_PLUGINS
 --env-system-python -> BLENDER_SYSTEM_PYTHON
2011-01-19 21:30:23 +00:00
Campbell Barton
161cbed9b5 new command line option '--factory-startup' to skip reading startup.blend. useful for testing with a predictable environment.
also commented python benchmark prints on exit, can enable when profiling later.
2011-01-19 09:13:24 +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
91f0e13686 update UI introspect function & man page 2010-12-31 15:09:05 +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
0c27782b8e update the man page from blenders --help message 2010-11-08 21:13:44 +00:00
Luca Bonavita
726e6d8530 == blender file format ==
- added a readme so that it's easy to understand how to use the py files.
- fixed typos in the usage message.
2010-11-01 13:27:33 +00:00
Luca Bonavita
e548e3e1d8 == blender file format ==
Hello, from the bconf 2010 from Jeroen and Luca. Our first combined commit :)

Automatically create sdna documentations from Trunk.

Usage: 
        blender2.5 -b -P BlendFileDnaExporter_25.py [-- [options]]
Options:
        --dna-keep-blend:      doesn't delete the produced blend file DNA export to html
        --dna-debug:           sets the logging level to DEBUG (lots of additional info)
        --dna-versioned'       saves version informations in the html and blend filenames
        --dna-overwrite-css'   overwrite dna.css, useful when modifying css in the script
Examples:
        default:       % blender2.5 -b -P BlendFileDnaExporter_25.py
        with options:  % blender2.5 -b -P BlendFileDnaExporter_25.py -- --dna-keep-blend --dna-debug
2010-10-30 13:25:24 +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
9f05cc59fa == docs ==
- moved files in proper directories and adapted paths where needed
- deleted doc/oldbugs.txt (asked confirmation to jesterking a week ago in irc)
- still working on doxygen files, for now I'll leave them in doc/
- NOTE: while checking if other files were referring to these files, I noted that
  "GPL-license.txt" is also used in the files below:
    - release/windows/installer/00.sconsblender.nsi
    - release/windows/specific.sh
  but these files should't be affected by this commit, but please check :)
2010-10-13 14:44:22 +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
Campbell Barton
115b256738 ran through pep8 checker 2010-09-07 15:17:42 +00:00
Guillermo S. Romero
a8269c8946 SVN maintenance. 2010-09-03 03:30:20 +00:00
Campbell Barton
7fc9eee08a - updated man page from --help output.
- cmake now installs the man page.
- added cmake_linux_install.sh, shell script which downloads and builds blender.
2010-07-15 19:58:23 +00:00
Campbell Barton
8e3a9634a3 Change to text3d: When back or front is enabled, the bevel rim on the other side is not created anymore, just as the back/front filling faces are not created when disabled.
when both are off the behavior is unchanged.

This is needed when rendering alpha text so its possible to have a single layer of faces but use the bevel option to make text thicker.
adding a rim on the back when back is disabled also doesnt make much sense IMHO.

minor python edits too.
2010-07-14 17:47:58 +00:00
Campbell Barton
3580d6229a - text3d was missing menu items for toggling bold/underline/italic/smallcaps.
- made smallcaps use a temp flag so caps can still have the smallcaps flag.
- utility function for getting the char from a font. find_vfont_char(), was inline in ~5 places.
- removed CU_STYLE mix of flags only used in one place, not needed. removed 'style' from rna too.
- fix for some warnings.
2010-07-13 23:51:21 +00:00
Campbell Barton
ea4e5a08cd script to create a man page from blenders --help text, replaced the hand edited man page with this. 2010-06-27 00:33:12 +00:00
Campbell Barton
1a3129c40a man page from debian updated for 2.5, better maintain here for other linux distros. 2010-06-07 15:37:59 +00:00
Campbell Barton
ed4377faa7 replace referenecs to python 2.x 2010-04-20 15:46:28 +00:00
Campbell Barton
081c1205a3 correct fsf address 2010-02-12 13:34:04 +00:00
Nathan Letwory
0a8e8c8c9e * add Brecht's small patch to make values to BF_QUICK and BF_QUICKDEBUG function as partial search entries.
- this means you can do BF_QUICK=bf_ and it would build all libs that contain bf_ in their name. This makes
    it easier to use, since you don't have to remember the exact names

* Update documentation to mention scons-local.
2008-11-09 21:00:49 +00:00
Nathan Letwory
027d86b9ff * doc update 2008-10-31 16:33:42 +00:00
Nathan Letwory
5d92376ef4 === SCons ===
* small doc update
2008-10-05 19:07:09 +00:00
Nathan Letwory
7a54b35a3e * add small bit of docs about BF_CONFIG 2008-04-28 09:41:51 +00:00
Jean-Luc Peurière
42b629a69b add the option of not installing to scons build system
settting WITHOUT_BF_INSTALL='true' will disable
 the copying to INSTALL_DIR

you can use that in your user-config.py or commandline

slipping in minor cleaning for Os X builds
2007-08-14 20:55:59 +00:00
Nathan Letwory
4b05da5612 * update version numbers for scons official stable. 2007-06-11 08:42:54 +00:00
Nathan Letwory
d40a7ba901 * update link to dependencies page. 2007-04-17 05:21:37 +00:00
Joilnen Leite
76240d9c10 fixing x2 param 2007-01-29 23:36:26 +00:00
Stephen Swaney
b13ee88805 added a note about using SCons version 0.96.1
problems reported with beta versions with mingw on forum.
2006-12-11 13:52:23 +00:00
Jacques Beuarain
cad803951a CMake: Provide better control over Python versions and library locations for both Mac and Unix and add to documentation 2006-12-06 08:52:43 +00:00
Jacques Beuarain
fd9415511a CMake: Initial commit of CMake usage document for Blender 2006-11-18 16:16:56 +00:00
Nathan Letwory
ff730aa486 * change Python version from 2.3 to 2.4, since it is a requirement for Blender anyway. Thanks to kalabalik for pointing out. 2006-09-01 07:06:55 +00:00
Nathan Letwory
8d9629cef9 ==SCons==
* The documentation for BF_QUICKDEBUG et al, missing from previous commit. Also
  provided by Joseph Eagar.
2006-03-17 16:42:43 +00:00
Nathan Letwory
9b239883f0 ==SCons==
* if you all look to the left, you won't see that on the right BF_PRIORITYLIST
  was spelled BF_PRIORITY_LIST twice.
2006-03-09 23:48:56 +00:00
Nathan Letwory
bbcfb14afa ==SCons==
+ Added note about using the config files. I repeat it here: a user NEVER
  should edit config/(platform)-config.py directly. Instead, make a copy of
  config/(platform)-config.py to user-config.py, and change that instead.

  /Nathan

  PS. now I can say "I told you", and be sure I will :P
2006-02-06 06:52:24 +00:00
Nathan Letwory
e46b74d18e == SCons ==
* Added a user and a developer doc for the upcoming SCons commits.
  These documents should get most people started after the commit
  of the new scripts is a fact.
2006-02-04 12:04:55 +00:00
Ton Roosendaal
c61f6463b1 Updated BL text.
This option has not been used for 3 years, and is very unlikely to happen
anytime.
2005-06-06 12:18:44 +00:00
Chris Burt
b8983996d2 Updated channel listing for help with compiling Blender to reflect (once
again) the existence of #blendercompilers. Also added link to updated
compiling guide found here:

http://www.blender3d.org/cms/Building_with_Cygwin.524.0.html

Thanks to Tom M. and joeedh for pointing out that it should be updated.
2005-03-22 23:38:34 +00:00
Kent Mein
300f10afc8 Tom's additions to the windows build.
(I changed #blendersaue to #blendercoders not #blendercompilers,
does anyone actually use #blendercompilers?)

Kent
2004-05-27 08:05:55 +00:00
Ton Roosendaal
dca4852482 Member added, who wasnt included due to wrong subscription. 2004-05-06 11:15:04 +00:00
Chris Want
5bd765b731 An update to the windows/gcc docs:
1) Explained the usage of the backslash at an end of a line
2) added note about new package gcc-g++
2004-04-11 19:30:26 +00:00
Ton Roosendaal
fe46c648e2 fix for description of UI_BLOCK_RET_1. 2003-11-21 13:16:04 +00:00
Ton Roosendaal
dbed089835 - text provided by Gregor Mueckl
describes the MEM_mallocN and MEM_callocN api
2003-08-27 17:46:59 +00:00
Ton Roosendaal
6d6936fa8f - interface.c doc 2003-08-04 12:40:09 +00:00
Casey Corn
9c9b8a9565 Enabled distributing group documentation, in order to make docs
cleaner.
2003-06-03 02:24:35 +00:00
Chris Want
fb76c8ac76 Updated the docs for building blender using cygwin/gcc.
Thanks for the input Pjotr!
2003-05-30 15:50:09 +00:00
Casey Corn
56c65a051a Added some input files and turned the INTERNAL_DOCS option on. 2003-05-30 01:48:17 +00:00
Casey Corn
ac3ca167e9 Turned on the EXTRACT_STATIC flag and added BUILD_DATE to
the PREDEFINED variables.  The generated docs will now show
documented static functions, and show the variables in buildinfo.c
2003-05-26 19:16:30 +00:00
Casey Corn
2d6b135345 Added ghost and imbuf to mainpage. 2003-05-24 20:48:29 +00:00
Casey Corn
c15bc23148 Added ghost, imbuf, and some src files to input, and switched on the
SOURCE_BROWSER flag to make the source code available in HTML
format.
2003-05-24 20:42:56 +00:00
Chris Want
924a849755 Support for building bf-blender under windows with gcc (huge thanks to
Florian Eggenburger).

Full instructions are in doc/README.windows-gcc.

Main differences from Florian's patch:

- the 'lib' dir should now be the same level as the 'blender' dir (rather
than being a subdir of 'blender'). This is consistent with the other
platforms that bf-blender supports (tuhopuu will also adopt this convention
hopefully soon).

- the script 'free_windows-env.mk' is no longer needed ... see the
docs about how this is overcome (again, tuhopuu will hopefully
also follow this route soon).

- the dlltool dir has it's own Makefile that builds all of the
needed stub libraries from the dll's in cvs.
2003-05-24 20:04:37 +00:00
Casey Corn
a4afbb1e28 Added group defaultconfig to group mainmodule. 2003-05-24 00:41:27 +00:00
Casey Corn
f293d6d676 This is the initial commit for the doxygen config file and the file which
defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
Kent Mein
64f0bdd954 Moved the misc txt files into the doc dir...
I wasn't sure maybe the two license files should be put in the root dir
instead....

I also reformated the bf-members.txt file a little to nuke extra spaces and
newlines (as well as updated my entry to include my name instead of just
sirdude... It looks like there are some special chars in it that someone
should fixup, not sure what they are suppose to be though)

Kent
2003-05-21 18:59:42 +00:00